Class Pipeline.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 Pipeline.Builder extends GeneratedMessage.Builder<Pipeline.Builder> implements PipelineOrBuilder

A Firestore query represented as an ordered list of operations / stages.

Protobuf type google.firestore.v1.Pipeline

Inheritance

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

Implements

PipelineOrBuilder

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

addAllStages(Iterable<? extends Pipeline.Stage> values)

public Pipeline.Builder addAllStages(Iterable<? extends Pipeline.Stage> values)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
Pipeline.Builder

addStages(Pipeline.Stage value)

public Pipeline.Builder addStages(Pipeline.Stage value)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Pipeline.Stage

Returns
Type	Description
Pipeline.Builder

addStages(Pipeline.Stage.Builder builderForValue)

public Pipeline.Builder addStages(Pipeline.Stage.Builder builderForValue)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	Pipeline.Stage.Builder

Returns
Type	Description
Pipeline.Builder

addStages(int index, Pipeline.Stage value)

public Pipeline.Builder addStages(int index, Pipeline.Stage value)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
value	Pipeline.Stage

Returns
Type	Description
Pipeline.Builder

addStages(int index, Pipeline.Stage.Builder builderForValue)

public Pipeline.Builder addStages(int index, Pipeline.Stage.Builder builderForValue)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
builderForValue	Pipeline.Stage.Builder

Returns
Type	Description
Pipeline.Builder

addStagesBuilder()

public Pipeline.Stage.Builder addStagesBuilder()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Pipeline.Stage.Builder

addStagesBuilder(int index)

public Pipeline.Stage.Builder addStagesBuilder(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Pipeline.Stage.Builder

build()

public Pipeline build()

Returns
Type	Description
Pipeline

buildPartial()

public Pipeline buildPartial()

Returns
Type	Description
Pipeline

clear()

public Pipeline.Builder clear()

Returns
Type	Description
Pipeline.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearStages()

public Pipeline.Builder clearStages()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Pipeline.Builder

getDefaultInstanceForType()

public Pipeline getDefaultInstanceForType()

Returns
Type	Description
Pipeline

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getStages(int index)

public Pipeline.Stage getStages(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Pipeline.Stage

getStagesBuilder(int index)

public Pipeline.Stage.Builder getStagesBuilder(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Pipeline.Stage.Builder

getStagesBuilderList()

public List<Pipeline.Stage.Builder> getStagesBuilderList()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Builder>

getStagesCount()

public int getStagesCount()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getStagesList()

public List<Pipeline.Stage> getStagesList()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Stage>

getStagesOrBuilder(int index)

public Pipeline.StageOrBuilder getStagesOrBuilder(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Pipeline.StageOrBuilder

getStagesOrBuilderList()

public List<? extends Pipeline.StageOrBuilder> getStagesOrBuilderList()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(Pipeline other)

public Pipeline.Builder mergeFrom(Pipeline other)

Parameter
Name	Description
other	Pipeline

Returns
Type	Description
Pipeline.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Pipeline.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Pipeline.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Pipeline.Builder

Overrides

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

removeStages(int index)

public Pipeline.Builder removeStages(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Pipeline.Builder

setStages(int index, Pipeline.Stage value)

public Pipeline.Builder setStages(int index, Pipeline.Stage value)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
value	Pipeline.Stage

Returns
Type	Description
Pipeline.Builder

setStages(int index, Pipeline.Stage.Builder builderForValue)

public Pipeline.Builder setStages(int index, Pipeline.Stage.Builder builderForValue)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
builderForValue	Pipeline.Stage.Builder

Returns
Type	Description
Pipeline.Builder