Class Pipeline.Stage (3.35.1)
Version latestkeyboard_arrow_down
public static final class Pipeline . Stage extends GeneratedMessageV3 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.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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
databyte []
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
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
indexint
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
indexint
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
keyString
defaultValueValue
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
keyString
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 GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection ( int number )
Parameter
Name Description
numberint
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Pipeline . Stage . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Pipeline . Stage . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Pipeline . Stage . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-23 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-23 UTC."],[],[]]
