Firestore v1 API - Class ExecutePipelineRequest (4.1.0) 

public sealed class ExecutePipelineRequest : IMessage<ExecutePipelineRequest>, IEquatable<ExecutePipelineRequest>, IDeepCloneable<ExecutePipelineRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class ExecutePipelineRequest.

The request for [Firestore.ExecutePipeline][google.firestore.v1.Firestore.ExecutePipeline].

Inheritance

object > ExecutePipelineRequest

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

ExecutePipelineRequest()

public ExecutePipelineRequest()

ExecutePipelineRequest(ExecutePipelineRequest)

public ExecutePipelineRequest(ExecutePipelineRequest other)
Parameter
Name Description
other ExecutePipelineRequest

Properties

ConsistencySelectorCase

public ExecutePipelineRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }
Property Value
Type Description
ExecutePipelineRequestConsistencySelectorOneofCase

Database

public string Database { get; set; }

Required. Database identifier, in the form projects/{project}/databases/{database}.

Property Value
Type Description
string

HasTransaction

public bool HasTransaction { get; }

Gets whether the "transaction" field is set

Property Value
Type Description
bool

NewTransaction

public TransactionOptions NewTransaction { get; set; }

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.

Property Value
Type Description
TransactionOptions

PipelineTypeCase

public ExecutePipelineRequest.PipelineTypeOneofCase PipelineTypeCase { get; }
Property Value
Type Description
ExecutePipelineRequestPipelineTypeOneofCase

ReadTime

public Timestamp ReadTime { get; set; }

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.

Property Value
Type Description
Timestamp

StructuredPipeline

public StructuredPipeline StructuredPipeline { get; set; }

A pipelined operation.

Property Value
Type Description
StructuredPipeline

Transaction

public ByteString Transaction { get; set; }

Run the query within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Property Value
Type Description
ByteString