public static final class ExecutePipelineRequest.Builder extends GeneratedMessageV3.Builder<ExecutePipelineRequest.Builder> implements ExecutePipelineRequestOrBuilderThe request for Firestore.ExecutePipeline.
Protobuf type google.firestore.v1.ExecutePipelineRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecutePipelineRequest.BuilderImplements
ExecutePipelineRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecutePipelineRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
build()
public ExecutePipelineRequest build()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest |
|
buildPartial()
public ExecutePipelineRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest |
|
clear()
public ExecutePipelineRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
clearConsistencySelector()
public ExecutePipelineRequest.Builder clearConsistencySelector()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
clearDatabase()
public ExecutePipelineRequest.Builder clearDatabase() Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ExecutePipelineRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
clearNewTransaction()
public ExecutePipelineRequest.Builder clearNewTransaction()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 |
ExecutePipelineRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecutePipelineRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
clearPipelineType()
public ExecutePipelineRequest.Builder clearPipelineType()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
clearReadTime()
public ExecutePipelineRequest.Builder clearReadTime()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 |
ExecutePipelineRequest.Builder |
|
clearStructuredPipeline()
public ExecutePipelineRequest.Builder clearStructuredPipeline()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
clearTransaction()
public ExecutePipelineRequest.Builder clearTransaction()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 |
ExecutePipelineRequest.Builder |
This builder for chaining. |
clone()
public ExecutePipelineRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
getConsistencySelectorCase()
public ExecutePipelineRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.ConsistencySelectorCase |
|
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()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
The newTransaction. |
getNewTransactionBuilder()
public TransactionOptions.Builder getNewTransactionBuilder()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 |
TransactionOptions.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
TransactionOptionsOrBuilder |
|
getPipelineTypeCase()
public ExecutePipelineRequest.PipelineTypeCase getPipelineTypeCase()| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.PipelineTypeCase |
|
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. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()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 |
Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getStructuredPipeline()
public StructuredPipeline getStructuredPipeline()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredPipeline |
The structuredPipeline. |
getStructuredPipelineBuilder()
public StructuredPipeline.Builder getStructuredPipelineBuilder()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredPipeline.Builder |
|
getStructuredPipelineOrBuilder()
public StructuredPipelineOrBuilder getStructuredPipelineOrBuilder()A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Returns | |
|---|---|
| Type | Description |
StructuredPipelineOrBuilder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ExecutePipelineRequest other)
public ExecutePipelineRequest.Builder mergeFrom(ExecutePipelineRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExecutePipelineRequest |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecutePipelineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExecutePipelineRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
mergeNewTransaction(TransactionOptions value)
public ExecutePipelineRequest.Builder mergeNewTransaction(TransactionOptions value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
TransactionOptions |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
mergeReadTime(Timestamp value)
public ExecutePipelineRequest.Builder mergeReadTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
mergeStructuredPipeline(StructuredPipeline value)
public ExecutePipelineRequest.Builder mergeStructuredPipeline(StructuredPipeline value)A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredPipeline |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecutePipelineRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setDatabase(String value)
public ExecutePipelineRequest.Builder setDatabase(String value) Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe database to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
This builder for chaining. |
setDatabaseBytes(ByteString value)
public ExecutePipelineRequest.Builder setDatabaseBytes(ByteString value) Required. Database identifier, in the form
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for database to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecutePipelineRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setNewTransaction(TransactionOptions value)
public ExecutePipelineRequest.Builder setNewTransaction(TransactionOptions value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
TransactionOptions |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setNewTransaction(TransactionOptions.Builder builderForValue)
public ExecutePipelineRequest.Builder setNewTransaction(TransactionOptions.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TransactionOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setReadTime(Timestamp value)
public ExecutePipelineRequest.Builder setReadTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setReadTime(Timestamp.Builder builderForValue)
public ExecutePipelineRequest.Builder setReadTime(Timestamp.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecutePipelineRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setStructuredPipeline(StructuredPipeline value)
public ExecutePipelineRequest.Builder setStructuredPipeline(StructuredPipeline value)A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredPipeline |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setStructuredPipeline(StructuredPipeline.Builder builderForValue)
public ExecutePipelineRequest.Builder setStructuredPipeline(StructuredPipeline.Builder builderForValue)A pipelined operation.
.google.firestore.v1.StructuredPipeline structured_pipeline = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StructuredPipeline.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|
setTransaction(ByteString value)
public ExecutePipelineRequest.Builder setTransaction(ByteString value)Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
bytes transaction = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe transaction to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecutePipelineRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecutePipelineRequest.Builder |
|