Package com.google.firestore.v1

Interface WriteOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Write, Write.Builder
public interface WriteOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasUpdate

      boolean hasUpdate()
       A document to write.
      .google.firestore.v1.Document update = 1;
      Returns:
      Whether the update field is set.

    • getUpdate

      Document getUpdate()
       A document to write.
      .google.firestore.v1.Document update = 1;
      Returns:
      The update.

    • getUpdateOrBuilder

      DocumentOrBuilder getUpdateOrBuilder()
       A document to write.
      .google.firestore.v1.Document update = 1;

    • hasDelete

      boolean hasDelete()
       A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string delete = 2;
      Returns:
      Whether the delete field is set.

    • getDelete

      String getDelete()
       A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string delete = 2;
      Returns:
      The delete.

    • getDeleteBytes

      com.google.protobuf.ByteString getDeleteBytes()
       A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string delete = 2;
      Returns:
      The bytes for delete.

    • hasTransform

      boolean hasTransform()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;
      Returns:
      Whether the transform field is set.

    • getTransform

      DocumentTransform getTransform()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;
      Returns:
      The transform.

    • getTransformOrBuilder

      DocumentTransformOrBuilder getTransformOrBuilder()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;

    • hasUpdateMask

      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:
      Whether the updateMask field is set.

    • getUpdateMask

      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:
      The updateMask.

    • getUpdateMaskOrBuilder

      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;

    • getUpdateTransformsList

      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;

    • getUpdateTransforms

      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;

    • getUpdateTransformsCount

      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;

    • getUpdateTransformsOrBuilderList

      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;

    • getUpdateTransformsOrBuilder

      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;

    • hasCurrentDocument

      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:
      Whether the currentDocument field is set.

    • getCurrentDocument

      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:
      The currentDocument.

    • getCurrentDocumentOrBuilder

      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;

    • getOperationCase

      Write.OperationCase getOperationCase()