Package com.google.firestore.v1

Interface GetDocumentRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    GetDocumentRequest.ConsistencySelectorCase
    getConsistencySelectorCase()
     
    DocumentMask
    getMask()
    The fields to return.
    DocumentMaskOrBuilder
    getMaskOrBuilder()
    The fields to return.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Timestamp
    getReadTime()
    Reads the version of the document at the given time.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    Reads the version of the document at the given time.
    com.google.protobuf.ByteString
    getTransaction()
    Reads the document in a transaction.
    boolean
    hasMask()
    The fields to return.
    boolean
    hasReadTime()
    Reads the version of the document at the given time.
    boolean
    hasTransaction()
    Reads the document in a transaction.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       Required. The resource name of the Document to get. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The resource name of the Document to get. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.

    • 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 = 2;
      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 = 2;
      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 = 2;

    • hasTransaction

      boolean hasTransaction()
       Reads the document in a transaction.
      bytes transaction = 3;
      Returns:
      Whether the transaction field is set.

    • getTransaction

      com.google.protobuf.ByteString getTransaction()
       Reads the document in a transaction.
      bytes transaction = 3;
      Returns:
      The transaction.

    • hasReadTime

      boolean hasReadTime()
       Reads the version of the document at the given time.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
      .google.protobuf.Timestamp read_time = 5;
      Returns:
      Whether the readTime field is set.

    • getReadTime

      com.google.protobuf.Timestamp getReadTime()
       Reads the version of the document at the given time.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
      .google.protobuf.Timestamp read_time = 5;
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       Reads the version of the document at the given time.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
      .google.protobuf.Timestamp read_time = 5;

    • getConsistencySelectorCase

      GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()