Class Function.Builder (3.36.0)

Version latest

• 3.36.0 (latest)
• 3.35.1
• 3.33.4
• 3.32.2
• 3.31.9
• 3.30.11
• 3.28.0
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class Function.Builder extends GeneratedMessage.Builder<Function.Builder> implements FunctionOrBuilder

Represents an unevaluated scalar expression.

For example, the expression like(user_name, "%alice%") is represented as:

<code><code> name: "like" args { field_reference: "user_name" } args { string_value: "%alice%" } </code></code>

Protobuf type google.firestore.v1.Function

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Function.Builder

Implements

FunctionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllArgs(Iterable<? extends Value> values)

public Function.Builder addAllArgs(Iterable<? extends Value> values)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.firestore.v1.Value>

Returns
Type	Description
Function.Builder

addArgs(Value value)

public Function.Builder addArgs(Value value)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Value

Returns
Type	Description
Function.Builder

addArgs(Value.Builder builderForValue)

public Function.Builder addArgs(Value.Builder builderForValue)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Value.Builder

Returns
Type	Description
Function.Builder

addArgs(int index, Value value)

public Function.Builder addArgs(int index, Value value)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
Function.Builder

addArgs(int index, Value.Builder builderForValue)

public Function.Builder addArgs(int index, Value.Builder builderForValue)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
Function.Builder

addArgsBuilder()

public Value.Builder addArgsBuilder()

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Value.Builder

addArgsBuilder(int index)

public Value.Builder addArgsBuilder(int index)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

build()

public Function build()

Returns
Type	Description
Function

buildPartial()

public Function buildPartial()

Returns
Type	Description
Function

clear()

public Function.Builder clear()

Returns
Type	Description
Function.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearArgs()

public Function.Builder clearArgs()

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Function.Builder

clearName()

public Function.Builder clearName()

Required. The name of the function to evaluate.

Requires:

• must be in snake case (lower case with underscore separator).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Function.Builder	This builder for chaining.

clearOptions()

public Function.Builder clearOptions()

Returns
Type	Description
Function.Builder

containsOptions(String key)

public boolean containsOptions(String key)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getArgs(int index)

public Value getArgs(int index)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Value

getArgsBuilder(int index)

public Value.Builder getArgsBuilder(int index)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

getArgsBuilderList()

public List<Value.Builder> getArgsBuilderList()

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getArgsCount()

public int getArgsCount()

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getArgsList()

public List<Value> getArgsList()

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Value>

getArgsOrBuilder(int index)

public ValueOrBuilder getArgsOrBuilder(int index)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
ValueOrBuilder

getArgsOrBuilderList()

public List<? extends ValueOrBuilder> getArgsOrBuilderList()

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.firestore.v1.ValueOrBuilder>

getDefaultInstanceForType()

public Function getDefaultInstanceForType()

Returns
Type	Description
Function

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getMutableOptions() (deprecated)

public Map<String,Value> getMutableOptions()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,Value>

getName()

public String getName()

Required. The name of the function to evaluate.

Requires:

• must be in snake case (lower case with underscore separator).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the function to evaluate.

Requires:

• must be in snake case (lower case with underscore separator).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for name.

getOptions() (deprecated)

public Map<String,Value> getOptions()

Use #getOptionsMap() instead.

Returns
Type	Description
Map<String,Value>

getOptionsCount()

public int getOptionsCount()

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getOptionsMap()

public Map<String,Value> getOptionsMap()

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,Value>

getOptionsOrDefault(String key, Value defaultValue)

public Value getOptionsOrDefault(String key, Value defaultValue)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	Value

Returns
Type	Description
Value

getOptionsOrThrow(String key)

public Value getOptionsOrThrow(String key)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Value

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(Function other)

public Function.Builder mergeFrom(Function other)

Parameter
Name	Description
other	Function

Returns
Type	Description
Function.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Function.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Function.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Function.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Function.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

putAllOptions(Map<String,Value> values)

public Function.Builder putAllOptions(Map<String,Value> values)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Map<String,Value>

Returns
Type	Description
Function.Builder

putOptions(String key, Value value)

public Function.Builder putOptions(String key, Value value)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
value	Value

Returns
Type	Description
Function.Builder

putOptionsBuilderIfAbsent(String key)

public Value.Builder putOptionsBuilderIfAbsent(String key)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Value.Builder

removeArgs(int index)

public Function.Builder removeArgs(int index)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Function.Builder

removeOptions(String key)

public Function.Builder removeOptions(String key)

Optional. Optional named arguments that certain functions may support.

map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Function.Builder

setArgs(int index, Value value)

public Function.Builder setArgs(int index, Value value)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
Function.Builder

setArgs(int index, Value.Builder builderForValue)

public Function.Builder setArgs(int index, Value.Builder builderForValue)

Optional. Ordered list of arguments the given function expects.

repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
Function.Builder

setName(String value)

public Function.Builder setName(String value)

Required. The name of the function to evaluate.

Requires:

• must be in snake case (lower case with underscore separator).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Function.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Function.Builder setNameBytes(ByteString value)

Required. The name of the function to evaluate.

Requires:

• must be in snake case (lower case with underscore separator).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Function.Builder	This builder for chaining.