Package com.google.firestore.v1

Interface UpdateDocumentRequestOrBuilder

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

  • Method Details

    • hasDocument

      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];
      Returns:
      Whether the document field is set.

    • getDocument

      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];
      Returns:
      The document.

    • getDocumentOrBuilder

      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];

    • hasUpdateMask

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

    • getUpdateMask

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

    • getUpdateMaskOrBuilder

      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;

    • hasMask

      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;
      Returns:
      Whether the mask field is set.

    • getMask

      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;
      Returns:
      The mask.

    • getMaskOrBuilder

      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;

    • hasCurrentDocument

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

    • getCurrentDocument

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

    • getCurrentDocumentOrBuilder

      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;