# Interface ExecutePipelineRequestOrBuilder (3.43.1)

3.43.1 (latest) 3.41.0 3.38.0 3.37.0 3.36.0 3.35.1 3.33.4 3.32.2 3.31.9 3.30.11 3.28.0 3.27.2 3.26.5 3.25.1 3.24.3 3.22.0 3.21.4 3.20.0 3.17.0 3.16.3 3.15.7 3.14.4 3.13.2 3.12.1 3.11.0 3.10.0 3.9.6 3.8.2 3.7.10 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.1.0 3.0.21

    public interface ExecutePipelineRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getAutoCommitTransaction()

    public abstract boolean getAutoCommitTransaction()

Optional. Automatically commits the transaction after the pipeline has been
executed. Only permitted in combination with `transaction` or
`new_transaction`.

`bool auto_commit_transaction = 9 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The autoCommitTransaction. |

### getConsistencySelectorCase()

    public abstract ExecutePipelineRequest.ConsistencySelectorCase getConsistencySelectorCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.firestore.v1.ExecutePipelineRequest.ConsistencySelectorCase` |   |

### getDatabase()

    public abstract String getDatabase()

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

`string database = 1 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The database. |

### getDatabaseBytes()

    public abstract ByteString getDatabaseBytes()

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

`string database = 1 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for database. |

### getNewTransaction()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.firestore.v1.TransactionOptions` | The newTransaction. |

### getNewTransactionOrBuilder()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.firestore.v1.TransactionOptionsOrBuilder` |   |

### getPipelineTypeCase()

    public abstract ExecutePipelineRequest.PipelineTypeCase getPipelineTypeCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.firestore.v1.ExecutePipelineRequest.PipelineTypeCase` |   |

### getReadTime()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | The readTime. |

### getReadTimeOrBuilder()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### getStructuredPipeline()

    public abstract StructuredPipeline getStructuredPipeline()

A pipelined operation.

`.google.firestore.v1.StructuredPipeline structured_pipeline = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.firestore.v1.StructuredPipeline` | The structuredPipeline. |

### getStructuredPipelineOrBuilder()

    public abstract StructuredPipelineOrBuilder getStructuredPipelineOrBuilder()

A pipelined operation.

`.google.firestore.v1.StructuredPipeline structured_pipeline = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.firestore.v1.StructuredPipelineOrBuilder` |   |

### getTransaction()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The transaction. |

### hasNewTransaction()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the newTransaction field is set. |

### hasReadTime()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the readTime field is set. |

### hasStructuredPipeline()

    public abstract boolean hasStructuredPipeline()

A pipelined operation.

`.google.firestore.v1.StructuredPipeline structured_pipeline = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the structuredPipeline field is set. |

### hasTransaction()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the transaction field is set. |