Interface WriteOrBuilder (3.6.0)

Version 3.6.0

• 3.28.0 (latest)
• 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 WriteOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCurrentDocument()

public abstract Precondition getCurrentDocument()

An optional precondition on the document. The write will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 4;

Returns

Type	Description
Precondition	The currentDocument.

getCurrentDocumentOrBuilder()

public abstract PreconditionOrBuilder getCurrentDocumentOrBuilder()

An optional precondition on the document. The write will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 4;

Returns

Type	Description
PreconditionOrBuilder

getDelete()

public abstract String getDelete()

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string delete = 2;

Returns

Type	Description
String	The delete.

getDeleteBytes()

public abstract ByteString getDeleteBytes()

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string delete = 2;

Returns

Type	Description
ByteString	The bytes for delete.

getOperationCase()

public abstract Write.OperationCase getOperationCase()

Returns

Type	Description
Write.OperationCase

getTransform()

public abstract DocumentTransform getTransform()

Applies a transformation to a document.

.google.firestore.v1.DocumentTransform transform = 6;

Returns

Type	Description
DocumentTransform	The transform.

getTransformOrBuilder()

public abstract DocumentTransformOrBuilder getTransformOrBuilder()

Applies a transformation to a document.

.google.firestore.v1.DocumentTransform transform = 6;

Returns

Type	Description
DocumentTransformOrBuilder

getUpdate()

public abstract Document getUpdate()

A document to write.

.google.firestore.v1.Document update = 1;

Returns

Type	Description
Document	The update.

getUpdateMask()

public abstract DocumentMask getUpdateMask()

The fields to update in this write. This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

.google.firestore.v1.DocumentMask update_mask = 3;

Returns

Type	Description
DocumentMask	The updateMask.

getUpdateMaskOrBuilder()

public abstract DocumentMaskOrBuilder getUpdateMaskOrBuilder()

The fields to update in this write. This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

.google.firestore.v1.DocumentMask update_mask = 3;

Returns

Type	Description
DocumentMaskOrBuilder

getUpdateOrBuilder()

public abstract DocumentOrBuilder getUpdateOrBuilder()

A document to write.

.google.firestore.v1.Document update = 1;

Returns

Type	Description
DocumentOrBuilder

getUpdateTransforms(int index)

public abstract DocumentTransform.FieldTransform getUpdateTransforms(int index)

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;

Parameter

Name	Description
index	int

Returns

Type	Description
DocumentTransform.FieldTransform

getUpdateTransformsCount()

public abstract int getUpdateTransformsCount()

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;

Returns

Type	Description
int

getUpdateTransformsList()

public abstract List<DocumentTransform.FieldTransform> getUpdateTransformsList()

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;

Returns

Type	Description
List<FieldTransform>

getUpdateTransformsOrBuilder(int index)

public abstract DocumentTransform.FieldTransformOrBuilder getUpdateTransformsOrBuilder(int index)

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;

Parameter

Name	Description
index	int

Returns

Type	Description
DocumentTransform.FieldTransformOrBuilder

getUpdateTransformsOrBuilderList()

public abstract List<? extends DocumentTransform.FieldTransformOrBuilder> getUpdateTransformsOrBuilderList()

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;

Returns

Type	Description
List<? extends com.google.firestore.v1.DocumentTransform.FieldTransformOrBuilder>

hasCurrentDocument()

public abstract boolean hasCurrentDocument()

An optional precondition on the document. The write will fail if this is set and not met by the target document.

.google.firestore.v1.Precondition current_document = 4;

Returns

Type	Description
boolean	Whether the currentDocument field is set.

hasDelete()

public abstract boolean hasDelete()

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string delete = 2;

Returns

Type	Description
boolean	Whether the delete field is set.

hasTransform()

public abstract boolean hasTransform()

Applies a transformation to a document.

.google.firestore.v1.DocumentTransform transform = 6;

Returns

Type	Description
boolean	Whether the transform field is set.

hasUpdate()

public abstract boolean hasUpdate()

A document to write.

.google.firestore.v1.Document update = 1;

Returns

Type	Description
boolean	Whether the update field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

The fields to update in this write. This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

.google.firestore.v1.DocumentMask update_mask = 3;

Returns

Type	Description
boolean	Whether the updateMask field is set.