Package com.google.firestore.v1

Class UpdateDocumentRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.UpdateDocumentRequest
All Implemented Interfaces:
UpdateDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class UpdateDocumentRequest extends com.google.protobuf.GeneratedMessageV3 implements UpdateDocumentRequestOrBuilder
 The request for
 [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
Protobuf type google.firestore.v1.UpdateDocumentRequest
See Also:

  • Field Details

    • DOCUMENT_FIELD_NUMBER

      public static final int DOCUMENT_FIELD_NUMBER
      See Also:

    • UPDATE_MASK_FIELD_NUMBER

      public static final int UPDATE_MASK_FIELD_NUMBER
      See Also:

    • MASK_FIELD_NUMBER

      public static final int MASK_FIELD_NUMBER
      See Also:

    • CURRENT_DOCUMENT_FIELD_NUMBER

      public static final int CURRENT_DOCUMENT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • hasDocument

      public boolean hasDocument()
       Required. The updated document.
 Creates the document if it does not already exist.
      .google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasDocument in interface UpdateDocumentRequestOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
       Required. The updated document.
 Creates the document if it does not already exist.
      .google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDocument in interface UpdateDocumentRequestOrBuilder
      Returns:
      The document.

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
       Required. The updated document.
 Creates the document if it does not already exist.
      .google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDocumentOrBuilder in interface UpdateDocumentRequestOrBuilder

    • hasUpdateMask

      public boolean hasUpdateMask()
       The fields to update.
 None of the field paths in the mask may contain a reserved name.

 If the document exists on the server and has fields not referenced in 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.
      .google.firestore.v1.DocumentMask update_mask = 2;
      Specified by:
      hasUpdateMask in interface UpdateDocumentRequestOrBuilder
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      public DocumentMask getUpdateMask()
       The fields to update.
 None of the field paths in the mask may contain a reserved name.

 If the document exists on the server and has fields not referenced in 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.
      .google.firestore.v1.DocumentMask update_mask = 2;
      Specified by:
      getUpdateMask in interface UpdateDocumentRequestOrBuilder
      Returns:
      The updateMask.

    • getUpdateMaskOrBuilder

      public DocumentMaskOrBuilder getUpdateMaskOrBuilder()
       The fields to update.
 None of the field paths in the mask may contain a reserved name.

 If the document exists on the server and has fields not referenced in 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.
      .google.firestore.v1.DocumentMask update_mask = 2;
      Specified by:
      getUpdateMaskOrBuilder in interface UpdateDocumentRequestOrBuilder

    • hasMask

      public boolean hasMask()
       The fields to return. If not set, returns all fields.

 If the document has a field that is not present in this mask, that field
 will not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;
      Specified by:
      hasMask in interface UpdateDocumentRequestOrBuilder
      Returns:
      Whether the mask field is set.

    • getMask

      public DocumentMask getMask()
       The fields to return. If not set, returns all fields.

 If the document has a field that is not present in this mask, that field
 will not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;
      Specified by:
      getMask in interface UpdateDocumentRequestOrBuilder
      Returns:
      The mask.

    • getMaskOrBuilder

      public DocumentMaskOrBuilder getMaskOrBuilder()
       The fields to return. If not set, returns all fields.

 If the document has a field that is not present in this mask, that field
 will not be returned in the response.
      .google.firestore.v1.DocumentMask mask = 3;
      Specified by:
      getMaskOrBuilder in interface UpdateDocumentRequestOrBuilder

    • hasCurrentDocument

      public boolean hasCurrentDocument()
       An optional precondition on the document.
 The request 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 UpdateDocumentRequestOrBuilder
      Returns:
      Whether the currentDocument field is set.

    • getCurrentDocument

      public Precondition getCurrentDocument()
       An optional precondition on the document.
 The request 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 UpdateDocumentRequestOrBuilder
      Returns:
      The currentDocument.

    • getCurrentDocumentOrBuilder

      public PreconditionOrBuilder getCurrentDocumentOrBuilder()
       An optional precondition on the document.
 The request 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 UpdateDocumentRequestOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UpdateDocumentRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateDocumentRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateDocumentRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UpdateDocumentRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UpdateDocumentRequest.Builder newBuilder()

    • newBuilder

      public static UpdateDocumentRequest.Builder newBuilder(UpdateDocumentRequest prototype)

    • toBuilder

      public UpdateDocumentRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UpdateDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static UpdateDocumentRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UpdateDocumentRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<UpdateDocumentRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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