Class StructuredPipeline.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 StructuredPipeline.Builder extends GeneratedMessageV3.Builder<StructuredPipeline.Builder> implements StructuredPipelineOrBuilder

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

This is considered the top-level function which plans and executes a query. It is logically equivalent to query(stages, options), but prevents the client from having to build a function wrapper.

Protobuf type google.firestore.v1.StructuredPipeline

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StructuredPipeline.Builder

Implements

StructuredPipelineOrBuilder

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

build()

public StructuredPipeline build()

Returns
Type	Description
StructuredPipeline

buildPartial()

public StructuredPipeline buildPartial()

Returns
Type	Description
StructuredPipeline

clear()

public StructuredPipeline.Builder clear()

Returns
Type	Description
StructuredPipeline.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public StructuredPipeline.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredPipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

clearOptions()

public StructuredPipeline.Builder clearOptions()

Returns
Type	Description
StructuredPipeline.Builder

clearPipeline()

public StructuredPipeline.Builder clearPipeline()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
StructuredPipeline.Builder

clone()

public StructuredPipeline.Builder clone()

Returns
Type	Description
StructuredPipeline.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsOptions(String key)

public boolean containsOptions(String key)

Optional. Optional query-level arguments.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getDefaultInstanceForType()

public StructuredPipeline getDefaultInstanceForType()

Returns
Type	Description
StructuredPipeline

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>

getOptions() (deprecated)

public Map<String,Value> getOptions()

Use #getOptionsMap() instead.

Returns
Type	Description
Map<String,Value>

getOptionsCount()

public int getOptionsCount()

Optional. Optional query-level arguments.

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

Returns
Type	Description
int

getOptionsMap()

public Map<String,Value> getOptionsMap()

Optional. Optional query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.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 query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.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 query-level arguments.

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

Parameter
Name	Description
key	String

Returns
Type	Description
Value

getPipeline()

public Pipeline getPipeline()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Pipeline	The pipeline.

getPipelineBuilder()

public Pipeline.Builder getPipelineBuilder()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Pipeline.Builder

getPipelineOrBuilder()

public PipelineOrBuilder getPipelineOrBuilder()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
PipelineOrBuilder

hasPipeline()

public boolean hasPipeline()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the pipeline field is set.

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(StructuredPipeline other)

public StructuredPipeline.Builder mergeFrom(StructuredPipeline other)

Parameter
Name	Description
other	StructuredPipeline

Returns
Type	Description
StructuredPipeline.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public StructuredPipeline.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

mergePipeline(Pipeline value)

public StructuredPipeline.Builder mergePipeline(Pipeline value)

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Pipeline

Returns
Type	Description
StructuredPipeline.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredPipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

putAllOptions(Map<String,Value> values)

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

Optional. Optional query-level arguments.

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

Parameter
Name	Description
values	Map<String,Value>

Returns
Type	Description
StructuredPipeline.Builder

putOptions(String key, Value value)

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

Optional. Optional query-level arguments.

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

Parameters
Name	Description
key	String
value	Value

Returns
Type	Description
StructuredPipeline.Builder

putOptionsBuilderIfAbsent(String key)

public Value.Builder putOptionsBuilderIfAbsent(String key)

Optional. Optional query-level arguments.

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

Parameter
Name	Description
key	String

Returns
Type	Description
Value.Builder

removeOptions(String key)

public StructuredPipeline.Builder removeOptions(String key)

Optional. Optional query-level arguments.

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

Parameter
Name	Description
key	String

Returns
Type	Description
StructuredPipeline.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

setPipeline(Pipeline value)

public StructuredPipeline.Builder setPipeline(Pipeline value)

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Pipeline

Returns
Type	Description
StructuredPipeline.Builder

setPipeline(Pipeline.Builder builderForValue)

public StructuredPipeline.Builder setPipeline(Pipeline.Builder builderForValue)

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	Pipeline.Builder

Returns
Type	Description
StructuredPipeline.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredPipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StructuredPipeline.Builder

Overrides

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