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
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
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>
|
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
|
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];
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
|
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];
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];
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
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Pipeline.Stage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public Pipeline.Stage build()
buildPartial()
public Pipeline.Stage buildPartial()
clear()
public Pipeline.Stage.Builder clear()
Overrides
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];
clearField(Descriptors.FieldDescriptor field)
public Pipeline.Stage.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public Pipeline.Stage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearOptions()
public Pipeline.Stage.Builder clearOptions()
clone()
public Pipeline.Stage.Builder clone()
Overrides
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
|
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
|
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];
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];
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
|
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableOptions() (deprecated)
public Map<String,Value> getMutableOptions()
Use alternate mutation accessors instead.
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()
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];
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()
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(Pipeline.Stage other)
public Pipeline.Stage.Builder mergeFrom(Pipeline.Stage other)
public Pipeline.Stage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Pipeline.Stage.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Pipeline.Stage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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];
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];
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
|
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
|
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
|
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
|
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];
setField(Descriptors.FieldDescriptor field, Object value)
public Pipeline.Stage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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.
|
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Pipeline.Stage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Pipeline.Stage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
