Package com.google.firestore.v1

Class ListDocumentsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>
com.google.firestore.v1.ListDocumentsRequest.Builder
All Implemented Interfaces:
ListDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListDocumentsRequest
public static final class ListDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder
 The request for
 [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].
Protobuf type google.firestore.v1.ListDocumentsRequest

  • 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<ListDocumentsRequest.Builder>

    • clear

      public ListDocumentsRequest.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<ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • setField

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • clearField

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • clearOneof

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • setRepeatedField

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • addRepeatedField

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • mergeFrom

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • mergeFrom

      public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

    • isInitialized

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

    • mergeFrom

      public ListDocumentsRequest.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<ListDocumentsRequest.Builder>
      Throws:
      IOException

    • getConsistencySelectorCase

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

    • clearConsistencySelector

      public ListDocumentsRequest.Builder clearConsistencySelector()

    • 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.

    • setParent

      public ListDocumentsRequest.Builder setParent(String value)
       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];
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListDocumentsRequest.Builder clearParent()
       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];
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListDocumentsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCollectionId

      public ListDocumentsRequest.Builder setCollectionId(String value)
       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];
      Parameters:
      value - The collectionId to set.
      Returns:
      This builder for chaining.

    • clearCollectionId

      public ListDocumentsRequest.Builder clearCollectionId()
       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];
      Returns:
      This builder for chaining.

    • setCollectionIdBytes

      public ListDocumentsRequest.Builder setCollectionIdBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for collectionId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageSize

      public ListDocumentsRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListDocumentsRequest.Builder clearPageSize()
       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];
      Returns:
      This builder for chaining.

    • 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.

    • setPageToken

      public ListDocumentsRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListDocumentsRequest.Builder clearPageToken()
       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];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListDocumentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setOrderBy

      public ListDocumentsRequest.Builder setOrderBy(String value)
       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];
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public ListDocumentsRequest.Builder clearOrderBy()
       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];
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public ListDocumentsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • 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.

    • setMask

      public ListDocumentsRequest.Builder setMask(DocumentMask value)
       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];

    • setMask

      public ListDocumentsRequest.Builder setMask(DocumentMask.Builder builderForValue)
       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];

    • mergeMask

      public ListDocumentsRequest.Builder mergeMask(DocumentMask value)
       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];

    • clearMask

      public ListDocumentsRequest.Builder clearMask()
       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];

    • getMaskBuilder

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

    • 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.

    • setTransaction

      public ListDocumentsRequest.Builder setTransaction(com.google.protobuf.ByteString value)
       Perform the read as part of an already active transaction.
      bytes transaction = 8;
      Parameters:
      value - The transaction to set.
      Returns:
      This builder for chaining.

    • clearTransaction

      public ListDocumentsRequest.Builder clearTransaction()
       Perform the read as part of an already active transaction.
      bytes transaction = 8;
      Returns:
      This builder for chaining.

    • 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.

    • setReadTime

      public ListDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
       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;

    • setReadTime

      public ListDocumentsRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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;

    • mergeReadTime

      public ListDocumentsRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       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;

    • clearReadTime

      public ListDocumentsRequest.Builder clearReadTime()
       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;

    • getReadTimeBuilder

      public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
       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;

    • 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.

    • setShowMissing

      public ListDocumentsRequest.Builder setShowMissing(boolean value)
       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;
      Parameters:
      value - The showMissing to set.
      Returns:
      This builder for chaining.

    • clearShowMissing

      public ListDocumentsRequest.Builder clearShowMissing()
       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;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ListDocumentsRequest.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<ListDocumentsRequest.Builder>

    • mergeUnknownFields

      public final ListDocumentsRequest.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<ListDocumentsRequest.Builder>