Class ExecutePipelineRequest (3.35.1)
Version latestkeyboard_arrow_down
public final class ExecutePipelineRequest extends GeneratedMessageV3 implements ExecutePipelineRequestOrBuilder
The request for
Firestore.ExecutePipeline .
Protobuf type google.firestore.v1.ExecutePipelineRequest
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
DATABASE_FIELD_NUMBER
public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int
NEW_TRANSACTION_FIELD_NUMBER
public static final int NEW_TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int
STRUCTURED_PIPELINE_FIELD_NUMBER
public static final int STRUCTURED_PIPELINE_FIELD_NUMBER
Field Value
Type Description
int
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ExecutePipelineRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ExecutePipelineRequest . Builder newBuilder ()
newBuilder(ExecutePipelineRequest prototype)
public static ExecutePipelineRequest . Builder newBuilder ( ExecutePipelineRequest prototype )
public static ExecutePipelineRequest parseDelimitedFrom ( InputStream input )
public static ExecutePipelineRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ExecutePipelineRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ExecutePipelineRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ExecutePipelineRequest parseFrom ( CodedInputStream input )
public static ExecutePipelineRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ExecutePipelineRequest parseFrom ( InputStream input )
public static ExecutePipelineRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ExecutePipelineRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecutePipelineRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ExecutePipelineRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getConsistencySelectorCase()
public ExecutePipelineRequest . ConsistencySelectorCase getConsistencySelectorCase ()
getDatabase()
public String getDatabase ()
Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The database.
getDatabaseBytes()
public ByteString getDatabaseBytes ()
Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for database.
getDefaultInstanceForType()
public ExecutePipelineRequest getDefaultInstanceForType ()
getNewTransaction()
public TransactionOptions getNewTransaction ()
Execute the pipeline in a new transaction.
The identifier of the newly created transaction will be returned in the
first response on the stream. This defaults to a read-only transaction.
.google.firestore.v1.TransactionOptions new_transaction = 6;
getNewTransactionOrBuilder()
public TransactionOptionsOrBuilder getNewTransactionOrBuilder ()
Execute the pipeline in a new transaction.
The identifier of the newly created transaction will be returned in the
first response on the stream. This defaults to a read-only transaction.
.google.firestore.v1.TransactionOptions new_transaction = 6;
getParserForType()
public Parser<ExecutePipelineRequest> getParserForType ()
Overrides
getPipelineTypeCase()
public ExecutePipelineRequest . PipelineTypeCase getPipelineTypeCase ()
getReadTime()
public Timestamp getReadTime ()
Execute the pipeline in a snapshot transaction at the given time.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 7;
Returns
Type Description
Timestamp The readTime.
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder ()
Execute the pipeline in a snapshot transaction at the given time.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 7;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getStructuredPipeline()
public StructuredPipeline getStructuredPipeline ()
A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
getStructuredPipelineOrBuilder()
public StructuredPipelineOrBuilder getStructuredPipelineOrBuilder ()
A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
getTransaction()
public ByteString getTransaction ()
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
Returns
Type Description
ByteString The transaction.
hasNewTransaction()
public boolean hasNewTransaction ()
Execute the pipeline in a new transaction.
The identifier of the newly created transaction will be returned in the
first response on the stream. This defaults to a read-only transaction.
.google.firestore.v1.TransactionOptions new_transaction = 6;
Returns
Type Description
boolean Whether the newTransaction field is set.
hasReadTime()
public boolean hasReadTime ()
Execute the pipeline in a snapshot transaction at the given time.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
.google.protobuf.Timestamp read_time = 7;
Returns
Type Description
boolean Whether the readTime field is set.
hasStructuredPipeline()
public boolean hasStructuredPipeline ()
A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
Returns
Type Description
boolean Whether the structuredPipeline field is set.
hasTransaction()
public boolean hasTransaction ()
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
Returns
Type Description
boolean Whether the transaction field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ExecutePipelineRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecutePipelineRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ExecutePipelineRequest . 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."],[],[]]
