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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredPipeline.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public StructuredPipeline build()
buildPartial()
public StructuredPipeline buildPartial()
clear()
public StructuredPipeline.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public StructuredPipeline.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredPipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearOptions()
public StructuredPipeline.Builder clearOptions()
clearPipeline()
public StructuredPipeline.Builder clearPipeline()
Required. The pipeline query to execute.
.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];
clone()
public StructuredPipeline.Builder clone()
Overrides
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
|
getDefaultInstanceForType()
public StructuredPipeline getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableOptions() (deprecated)
public Map<String,Value> getMutableOptions()
Use alternate mutation accessors instead.
getOptions() (deprecated)
public Map<String,Value> getOptions()
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];
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];
getPipelineOrBuilder()
public PipelineOrBuilder getPipelineOrBuilder()
Required. The pipeline query to execute.
.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];
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()
Overrides
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()
Overrides
mergeFrom(StructuredPipeline other)
public StructuredPipeline.Builder mergeFrom(StructuredPipeline other)
public StructuredPipeline.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public StructuredPipeline.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
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
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredPipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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];
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];
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
|
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
|
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredPipeline.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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
|
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];
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredPipeline.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredPipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
