3.45.0 (latest) 3.44.0 3.43.1 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 abstract class Transaction extends UpdateBuilder<Transaction>

A Transaction is passed to a Function to provide the methods to read and write data within the
transaction context.
See Also: [Firestore#runTransaction(Function)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.Firestore#com_google_cloud_firestore_Firestore_runTransaction_)

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> [UpdateBuilder](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder) \> Transaction

## Inherited Members

[UpdateBuilder.className()](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_className__) [UpdateBuilder.create(DocumentReference,Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_create_com_google_cloud_firestore_DocumentReference_java_lang_Object_) [UpdateBuilder.create(DocumentReference,Map\<String,Object\>)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_create_com_google_cloud_firestore_DocumentReference_java_util_Map_java_lang_String_java_lang_Object__) [UpdateBuilder.delete(DocumentReference)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_delete_com_google_cloud_firestore_DocumentReference_) [UpdateBuilder.delete(DocumentReference,Precondition)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_delete_com_google_cloud_firestore_DocumentReference_com_google_cloud_firestore_Precondition_) [UpdateBuilder.getMutationsSize()](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_getMutationsSize__) [UpdateBuilder.set(DocumentReference,Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_set_com_google_cloud_firestore_DocumentReference_java_lang_Object_) [UpdateBuilder.set(DocumentReference,Object,SetOptions)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_set_com_google_cloud_firestore_DocumentReference_java_lang_Object_com_google_cloud_firestore_SetOptions_) [UpdateBuilder.set(DocumentReference,Map\<String,Object\>)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_set_com_google_cloud_firestore_DocumentReference_java_util_Map_java_lang_String_java_lang_Object__) [UpdateBuilder.set(DocumentReference,Map\<String,Object\>,SetOptions)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_set_com_google_cloud_firestore_DocumentReference_java_util_Map_java_lang_String_java_lang_Object__com_google_cloud_firestore_SetOptions_) [UpdateBuilder.toString()](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_toString__) [UpdateBuilder.update(DocumentReference,FieldPath,Object,Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_update_com_google_cloud_firestore_DocumentReference_com_google_cloud_firestore_FieldPath_java_lang_Object_java_lang_Object____) [UpdateBuilder.update(DocumentReference,Precondition,FieldPath,Object,Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_update_com_google_cloud_firestore_DocumentReference_com_google_cloud_firestore_Precondition_com_google_cloud_firestore_FieldPath_java_lang_Object_java_lang_Object____) [UpdateBuilder.update(DocumentReference,Precondition,String,Object,Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_update_com_google_cloud_firestore_DocumentReference_com_google_cloud_firestore_Precondition_java_lang_String_java_lang_Object_java_lang_Object____) [UpdateBuilder.update(DocumentReference,String,Object,Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_update_com_google_cloud_firestore_DocumentReference_java_lang_String_java_lang_Object_java_lang_Object____) [UpdateBuilder.update(DocumentReference,Map\<String,Object\>)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_update_com_google_cloud_firestore_DocumentReference_java_util_Map_java_lang_String_java_lang_Object__) [UpdateBuilder.update(DocumentReference,Map\<String,Object\>,Precondition)](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_update_com_google_cloud_firestore_DocumentReference_java_util_Map_java_lang_String_java_lang_Object__com_google_cloud_firestore_Precondition_) [Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Constructors

### Transaction(FirestoreImpl firestore)

    protected Transaction(FirestoreImpl firestore)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `firestore` | `com.google.cloud.firestore.FirestoreImpl` |

## Fields

### transactionTraceContext

    protected TraceUtil.Context transactionTraceContext

| **Field Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.telemetry.TraceUtil.Context` |   |

## Methods

### className()

    protected String className()

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

**Overrides** [UpdateBuilder\<T\>.className()](https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.UpdateBuilder#com_google_cloud_firestore_UpdateBuilder_className__)

### execute(Pipeline pipeline)

    public abstract ApiFuture<Pipeline.Snapshot> execute(Pipeline pipeline)

Executes the provided pipeline within the transaction context.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `pipeline` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.Pipeline` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.Pipeline.Snapshot>` | The result of the execution. |

### execute(Pipeline pipeline, PipelineExecuteOptions options)

    public abstract ApiFuture<Pipeline.Snapshot> execute(Pipeline pipeline, PipelineExecuteOptions options)

Executes the provided pipeline with specified options, within the transaction context.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `pipeline` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.Pipeline` |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.pipeline.stages.PipelineExecuteOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.Pipeline.Snapshot>` | The result of the execution. |

### get(AggregateQuery query)

    public abstract ApiFuture<AggregateQuerySnapshot> get(AggregateQuery query)

Returns the result from the provided aggregate query. Holds a pessimistic lock on all accessed
documents.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `query` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.AggregateQuery` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.AggregateQuerySnapshot>` | The result of the aggregation. |

### get(DocumentReference documentRef)

    public abstract ApiFuture<DocumentSnapshot> get(DocumentReference documentRef)

Reads the document referred to by the provided DocumentReference. Holds a pessimistic lock on
the returned document.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `documentRef` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentReference` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentSnapshot>` | The contents of the Document at this DocumentReference. |

### get(Query query)

    public abstract ApiFuture<QuerySnapshot> get(Query query)

Returns the result set from the provided query. Holds a pessimistic lock on all returned
documents.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `query` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.Query` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.QuerySnapshot>` | The contents of the Document at this DocumentReference. |

### getAll(DocumentReference\[\] documentReferences)

    public abstract ApiFuture<List<DocumentSnapshot>> getAll(DocumentReference[] documentReferences)

Retrieves multiple documents from Firestore. Holds a pessimistic lock on all returned
documents.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `documentReferences` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentReference[]` List of Document References to fetch. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentSnapshot>>` |   |

### getAll(DocumentReference\[\] documentReferences, FieldMask fieldMask)

    public abstract ApiFuture<List<DocumentSnapshot>> getAll(DocumentReference[] documentReferences, FieldMask fieldMask)

Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce
the amount of data transmitted from the backend. Holds a pessimistic lock on all returned
documents.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `documentReferences` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentReference[]` Array with Document References to fetch. |
| `fieldMask` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.FieldMask` If set, specifies the subset of fields to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.DocumentSnapshot>>` |   |

### hasTransactionId()

    public abstract boolean hasTransactionId()

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