Package com.google.firestore.v1

Class ListDocumentsRequest

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

  • Field Details

  • 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

    • getConsistencySelectorCase

      public ListDocumentsRequest.ConsistencySelectorCase getConsistencySelectorCase()
      Specified by:
      getConsistencySelectorCase in interface ListDocumentsRequestOrBuilder

    • getParent

      public String getParent()
       Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getParent in interface ListDocumentsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getParentBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getCollectionId

      public String getCollectionId()
       Optional. The collection ID, relative to `parent`, to list.

 For example: `chatrooms` or `messages`.

 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.
      string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCollectionId in interface ListDocumentsRequestOrBuilder
      Returns:
      The collectionId.

    • getCollectionIdBytes

      public com.google.protobuf.ByteString getCollectionIdBytes()
       Optional. The collection ID, relative to `parent`, to list.

 For example: `chatrooms` or `messages`.

 This is optional, and when not provided, Firestore will list documents
 from all collections under the provided `parent`.
      string collection_id = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCollectionIdBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for collectionId.

    • getPageSize

      public int getPageSize()
       Optional. The maximum number of documents to return in a single response.

 Firestore may return fewer than this value.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListDocumentsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. A page token, received from a previous `ListDocuments` response.

 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListDocumentsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A page token, received from a previous `ListDocuments` response.

 Provide this to retrieve the subsequent page. When paginating, all other
 parameters (with the exception of `page_size`) must match the values set
 in the request that generated the page token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getOrderBy

      public String getOrderBy()
       Optional. The optional ordering of the documents to return.

 For example: `priority desc, __name__ desc`.

 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.
      string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderBy in interface ListDocumentsRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       Optional. The optional ordering of the documents to return.

 For example: `priority desc, __name__ desc`.

 This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
 used in Firestore queries but in a string representation. When absent,
 documents are ordered based on `__name__ ASC`.
      string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderByBytes in interface ListDocumentsRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • hasMask

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

 If a 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 = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMask in interface ListDocumentsRequestOrBuilder
      Returns:
      Whether the mask field is set.

    • getMask

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

 If a 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 = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMask in interface ListDocumentsRequestOrBuilder
      Returns:
      The mask.

    • getMaskOrBuilder

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

 If a 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 = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMaskOrBuilder in interface ListDocumentsRequestOrBuilder

    • hasTransaction

      public boolean hasTransaction()
       Perform the read as part of an already active transaction.
      bytes transaction = 8;
      Specified by:
      hasTransaction in interface ListDocumentsRequestOrBuilder
      Returns:
      Whether the transaction field is set.

    • getTransaction

      public com.google.protobuf.ByteString getTransaction()
       Perform the read as part of an already active transaction.
      bytes transaction = 8;
      Specified by:
      getTransaction in interface ListDocumentsRequestOrBuilder
      Returns:
      The transaction.

    • hasReadTime

      public boolean hasReadTime()
       Perform the read at the provided 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 = 10;
      Specified by:
      hasReadTime in interface ListDocumentsRequestOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       Perform the read at the provided 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 = 10;
      Specified by:
      getReadTime in interface ListDocumentsRequestOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       Perform the read at the provided 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 = 10;
      Specified by:
      getReadTimeOrBuilder in interface ListDocumentsRequestOrBuilder

    • getShowMissing

      public boolean getShowMissing()
       If the list should show missing documents.

 A document is missing if it does not exist, but there are sub-documents
 nested underneath it. When true, such missing documents will be returned
 with a key but will not have fields,
 [`create_time`][google.firestore.v1.Document.create_time], or
 [`update_time`][google.firestore.v1.Document.update_time] set.

 Requests with `show_missing` may not specify `where` or `order_by`.
      bool show_missing = 12;
      Specified by:
      getShowMissing in interface ListDocumentsRequestOrBuilder
      Returns:
      The showMissing.

    • 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 ListDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListDocumentsRequest.Builder newBuilder()

    • newBuilder

      public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListDocumentsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ListDocumentsRequest> 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 ListDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder