public static final class Pipeline.Stage extends GeneratedMessage 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.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
ARGS_FIELD_NUMBER
public static final int ARGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Pipeline.Stage getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Pipeline.Stage.Builder newBuilder()
newBuilder(Pipeline.Stage prototype)
public static Pipeline.Stage.Builder newBuilder(Pipeline.Stage prototype)
public static Pipeline.Stage parseDelimitedFrom(InputStream input)
public static Pipeline.Stage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Pipeline.Stage parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Pipeline.Stage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Pipeline.Stage parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Pipeline.Stage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Pipeline.Stage parseFrom(CodedInputStream input)
public static Pipeline.Stage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Pipeline.Stage parseFrom(InputStream input)
public static Pipeline.Stage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Pipeline.Stage parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Pipeline.Stage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Pipeline.Stage> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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 |
|
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()
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 |
|
getParserForType()
public Parser<Pipeline.Stage> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.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.GeneratedMessage.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Pipeline.Stage.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Pipeline.Stage.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Pipeline.Stage.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
