Class Pipeline.Stage.Builder (3.35.1)

Version latest

• 3.35.1 (latest)
• 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 Pipeline.Stage.Builder extends GeneratedMessageV3.Builder<Pipeline.Stage.Builder> implements Pipeline.StageOrBuilder

A single operation within a pipeline.

A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type.

To give an example, the stage filter(state = "MD") would be encoded as:

<code><code> name: "filter" args { function_value { name: "eq" args { field_reference_value: "state" } args { string_value: "MD" } } } </code></code>

See public documentation for the full list.

Protobuf type google.firestore.v1.Pipeline.Stage

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Pipeline.Stage.Builder

Implements

Pipeline.StageOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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 Pipeline.Stage.Builder addAllArgs(Iterable<? extends Value> values)

Optional. Ordered list of arguments the given stage 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
Pipeline.Stage.Builder

addArgs(Value value)

public Pipeline.Stage.Builder addArgs(Value value)

Optional. Ordered list of arguments the given stage expects.

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

Parameter
Name	Description
value	Value

Returns
Type	Description
Pipeline.Stage.Builder

addArgs(Value.Builder builderForValue)

public Pipeline.Stage.Builder addArgs(Value.Builder builderForValue)

Optional. Ordered list of arguments the given stage expects.

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

Parameter
Name	Description
builderForValue	Value.Builder

Returns
Type	Description
Pipeline.Stage.Builder

addArgs(int index, Value value)

public Pipeline.Stage.Builder addArgs(int index, Value value)

Optional. Ordered list of arguments the given stage expects.

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

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
Pipeline.Stage.Builder

addArgs(int index, Value.Builder builderForValue)

public Pipeline.Stage.Builder addArgs(int index, Value.Builder builderForValue)

Optional. Ordered list of arguments the given stage expects.

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

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
Pipeline.Stage.Builder

addArgsBuilder()

public Value.Builder addArgsBuilder()

Optional. Ordered list of arguments the given stage 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 stage expects.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Stage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Pipeline.Stage build()

Returns
Type	Description
Pipeline.Stage

buildPartial()

public Pipeline.Stage buildPartial()

Returns
Type	Description
Pipeline.Stage

clear()

public Pipeline.Stage.Builder clear()

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArgs()

public Pipeline.Stage.Builder clearArgs()

Optional. Ordered list of arguments the given stage expects.

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

Returns
Type	Description
Pipeline.Stage.Builder

clearField(Descriptors.FieldDescriptor field)

public Pipeline.Stage.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public Pipeline.Stage.Builder clearName()

Required. The name of the stage to evaluate.

Requires:

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

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

Returns
Type	Description
Pipeline.Stage.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Pipeline.Stage.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOptions()

public Pipeline.Stage.Builder clearOptions()

Returns
Type	Description
Pipeline.Stage.Builder

clone()

public Pipeline.Stage.Builder clone()

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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 stage 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 stage 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 stage 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 stage 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 stage 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 stage 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 stage 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 Pipeline.Stage getDefaultInstanceForType()

Returns
Type	Description
Pipeline.Stage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.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 stage 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 stage 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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Pipeline.Stage other)

public Pipeline.Stage.Builder mergeFrom(Pipeline.Stage other)

Parameter
Name	Description
other	Pipeline.Stage

Returns
Type	Description
Pipeline.Stage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Pipeline.Stage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Pipeline.Stage.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Stage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllOptions(Map<String,Value> values)

public Pipeline.Stage.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
Pipeline.Stage.Builder

putOptions(String key, Value value)

public Pipeline.Stage.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
Pipeline.Stage.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 Pipeline.Stage.Builder removeArgs(int index)

Optional. Ordered list of arguments the given stage expects.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Pipeline.Stage.Builder

removeOptions(String key)

public Pipeline.Stage.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
Pipeline.Stage.Builder

setArgs(int index, Value value)

public Pipeline.Stage.Builder setArgs(int index, Value value)

Optional. Ordered list of arguments the given stage expects.

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

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
Pipeline.Stage.Builder

setArgs(int index, Value.Builder builderForValue)

public Pipeline.Stage.Builder setArgs(int index, Value.Builder builderForValue)

Optional. Ordered list of arguments the given stage expects.

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

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
Pipeline.Stage.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Stage.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Pipeline.Stage.Builder setName(String value)

Required. The name of the stage 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
Pipeline.Stage.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Pipeline.Stage.Builder setNameBytes(ByteString value)

Required. The name of the stage 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
Pipeline.Stage.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Pipeline.Stage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Stage.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Pipeline.Stage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)