Send feedback
Class StructuredPipeline (3.35.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class StructuredPipeline extends GeneratedMessageV3 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.<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
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
Field Value
Type Description
int
PIPELINE_FIELD_NUMBER
public static final int PIPELINE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static StructuredPipeline getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static StructuredPipeline . Builder newBuilder ()
newBuilder(StructuredPipeline prototype)
public static StructuredPipeline . Builder newBuilder ( StructuredPipeline prototype )
public static StructuredPipeline parseDelimitedFrom ( InputStream input )
public static StructuredPipeline parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static StructuredPipeline parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredPipeline parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static StructuredPipeline parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredPipeline parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static StructuredPipeline parseFrom ( CodedInputStream input )
public static StructuredPipeline parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static StructuredPipeline parseFrom ( InputStream input )
public static StructuredPipeline parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static StructuredPipeline parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredPipeline parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<StructuredPipeline> parser ()
Methods
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
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public StructuredPipeline getDefaultInstanceForType ()
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
keyString
defaultValueValue
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
keyString
Returns
Type Description
Value
getParserForType()
public Parser<StructuredPipeline> getParserForType ()
Overrides
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.
getPipelineOrBuilder()
public PipelineOrBuilder getPipelineOrBuilder ()
Required. The pipeline query to execute.
.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
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 StructuredPipeline . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredPipeline . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public StructuredPipeline . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-23 UTC."],[],[]]
