Package com.google.firestore.v1

Class Write.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>
com.google.firestore.v1.Write.Builder
All Implemented Interfaces:
WriteOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Write
public static final class Write.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder> implements WriteOrBuilder
 A write on a document.
Protobuf type google.firestore.v1.Write

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • clear

      public Write.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • getDefaultInstanceForType

      public Write getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Write build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Write buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Write.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • setField

      public Write.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • clearField

      public Write.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • clearOneof

      public Write.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • setRepeatedField

      public Write.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • addRepeatedField

      public Write.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • mergeFrom

      public Write.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Write.Builder>

    • mergeFrom

      public Write.Builder mergeFrom(Write other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • mergeFrom

      public Write.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Write.Builder>
      Throws:
      IOException

    • getOperationCase

      public Write.OperationCase getOperationCase()
      Specified by:
      getOperationCase in interface WriteOrBuilder

    • clearOperation

      public Write.Builder clearOperation()

    • hasUpdate

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

    • getUpdate

      public Document getUpdate()
       A document to write.
      .google.firestore.v1.Document update = 1;
      Specified by:
      getUpdate in interface WriteOrBuilder
      Returns:
      The update.

    • setUpdate

      public Write.Builder setUpdate(Document value)
       A document to write.
      .google.firestore.v1.Document update = 1;

    • setUpdate

      public Write.Builder setUpdate(Document.Builder builderForValue)
       A document to write.
      .google.firestore.v1.Document update = 1;

    • mergeUpdate

      public Write.Builder mergeUpdate(Document value)
       A document to write.
      .google.firestore.v1.Document update = 1;

    • clearUpdate

      public Write.Builder clearUpdate()
       A document to write.
      .google.firestore.v1.Document update = 1;

    • getUpdateBuilder

      public Document.Builder getUpdateBuilder()
       A document to write.
      .google.firestore.v1.Document update = 1;

    • getUpdateOrBuilder

      public DocumentOrBuilder getUpdateOrBuilder()
       A document to write.
      .google.firestore.v1.Document update = 1;
      Specified by:
      getUpdateOrBuilder in interface WriteOrBuilder

    • hasDelete

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

    • getDelete

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

    • getDeleteBytes

      public 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;
      Specified by:
      getDeleteBytes in interface WriteOrBuilder
      Returns:
      The bytes for delete.

    • setDelete

      public Write.Builder setDelete(String value)
       A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string delete = 2;
      Parameters:
      value - The delete to set.
      Returns:
      This builder for chaining.

    • clearDelete

      public Write.Builder clearDelete()
       A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string delete = 2;
      Returns:
      This builder for chaining.

    • setDeleteBytes

      public Write.Builder setDeleteBytes(com.google.protobuf.ByteString value)
       A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string delete = 2;
      Parameters:
      value - The bytes for delete to set.
      Returns:
      This builder for chaining.

    • hasTransform

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

    • getTransform

      public DocumentTransform getTransform()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;
      Specified by:
      getTransform in interface WriteOrBuilder
      Returns:
      The transform.

    • setTransform

      public Write.Builder setTransform(DocumentTransform value)
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;

    • setTransform

      public Write.Builder setTransform(DocumentTransform.Builder builderForValue)
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;

    • mergeTransform

      public Write.Builder mergeTransform(DocumentTransform value)
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;

    • clearTransform

      public Write.Builder clearTransform()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;

    • getTransformBuilder

      public DocumentTransform.Builder getTransformBuilder()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;

    • getTransformOrBuilder

      public DocumentTransformOrBuilder getTransformOrBuilder()
       Applies a transformation to a document.
      .google.firestore.v1.DocumentTransform transform = 6;
      Specified by:
      getTransformOrBuilder in interface WriteOrBuilder

    • hasUpdateMask

      public 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;
      Specified by:
      hasUpdateMask in interface WriteOrBuilder
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      public 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;
      Specified by:
      getUpdateMask in interface WriteOrBuilder
      Returns:
      The updateMask.

    • setUpdateMask

      public Write.Builder setUpdateMask(DocumentMask value)
       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;

    • setUpdateMask

      public Write.Builder setUpdateMask(DocumentMask.Builder builderForValue)
       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;

    • mergeUpdateMask

      public Write.Builder mergeUpdateMask(DocumentMask value)
       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;

    • clearUpdateMask

      public Write.Builder clearUpdateMask()
       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;

    • getUpdateMaskBuilder

      public DocumentMask.Builder getUpdateMaskBuilder()
       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;

    • getUpdateMaskOrBuilder

      public 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;
      Specified by:
      getUpdateMaskOrBuilder in interface WriteOrBuilder

    • getUpdateTransformsList

      public 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;
      Specified by:
      getUpdateTransformsList in interface WriteOrBuilder

    • getUpdateTransformsCount

      public 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;
      Specified by:
      getUpdateTransformsCount in interface WriteOrBuilder

    • getUpdateTransforms

      public 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;
      Specified by:
      getUpdateTransforms in interface WriteOrBuilder

    • setUpdateTransforms

      public Write.Builder setUpdateTransforms(int index, DocumentTransform.FieldTransform value)
       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;

    • setUpdateTransforms

      public Write.Builder setUpdateTransforms(int index, DocumentTransform.FieldTransform.Builder builderForValue)
       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;

    • addUpdateTransforms

      public Write.Builder addUpdateTransforms(DocumentTransform.FieldTransform value)
       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;

    • addUpdateTransforms

      public Write.Builder addUpdateTransforms(int index, DocumentTransform.FieldTransform value)
       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;

    • addUpdateTransforms

      public Write.Builder addUpdateTransforms(DocumentTransform.FieldTransform.Builder builderForValue)
       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;

    • addUpdateTransforms

      public Write.Builder addUpdateTransforms(int index, DocumentTransform.FieldTransform.Builder builderForValue)
       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;

    • addAllUpdateTransforms

      public Write.Builder addAllUpdateTransforms(Iterable<? extends DocumentTransform.FieldTransform> values)
       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;

    • clearUpdateTransforms

      public Write.Builder clearUpdateTransforms()
       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;

    • removeUpdateTransforms

      public Write.Builder removeUpdateTransforms(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;

    • getUpdateTransformsBuilder

      public DocumentTransform.FieldTransform.Builder getUpdateTransformsBuilder(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;

    • getUpdateTransformsOrBuilder

      public 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;
      Specified by:
      getUpdateTransformsOrBuilder in interface WriteOrBuilder

    • getUpdateTransformsOrBuilderList

      public 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;
      Specified by:
      getUpdateTransformsOrBuilderList in interface WriteOrBuilder

    • addUpdateTransformsBuilder

      public DocumentTransform.FieldTransform.Builder addUpdateTransformsBuilder()
       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;

    • addUpdateTransformsBuilder

      public DocumentTransform.FieldTransform.Builder addUpdateTransformsBuilder(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;

    • getUpdateTransformsBuilderList

      public List<DocumentTransform.FieldTransform.Builder> getUpdateTransformsBuilderList()
       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

      public 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;
      Specified by:
      hasCurrentDocument in interface WriteOrBuilder
      Returns:
      Whether the currentDocument field is set.

    • getCurrentDocument

      public 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;
      Specified by:
      getCurrentDocument in interface WriteOrBuilder
      Returns:
      The currentDocument.

    • setCurrentDocument

      public Write.Builder setCurrentDocument(Precondition value)
       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;

    • setCurrentDocument

      public Write.Builder setCurrentDocument(Precondition.Builder builderForValue)
       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;

    • mergeCurrentDocument

      public Write.Builder mergeCurrentDocument(Precondition value)
       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;

    • clearCurrentDocument

      public Write.Builder clearCurrentDocument()
       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;

    • getCurrentDocumentBuilder

      public Precondition.Builder getCurrentDocumentBuilder()
       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;

    • getCurrentDocumentOrBuilder

      public 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;
      Specified by:
      getCurrentDocumentOrBuilder in interface WriteOrBuilder

    • setUnknownFields

      public final Write.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>

    • mergeUnknownFields

      public final Write.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>