Package com.google.firestore.v1

Class ListCollectionIdsRequest.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public ListCollectionIdsRequest.Builder mergeFrom(ListCollectionIdsRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getConsistencySelectorCase

      public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()
      Specified by:
      getConsistencySelectorCase in interface ListCollectionIdsRequestOrBuilder

    • clearConsistencySelector

      public ListCollectionIdsRequest.Builder clearConsistencySelector()

    • getParent

      public String getParent()
       Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getParent in interface ListCollectionIdsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getParentBytes in interface ListCollectionIdsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListCollectionIdsRequest.Builder setParent(String value)
       Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `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 ListCollectionIdsRequest.Builder clearParent()
       Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `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 ListCollectionIdsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The parent document. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `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.

    • getPageSize

      public int getPageSize()
       The maximum number of results to return.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListCollectionIdsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListCollectionIdsRequest.Builder setPageSize(int value)
       The maximum number of results to return.
      int32 page_size = 2;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListCollectionIdsRequest.Builder clearPageSize()
       The maximum number of results to return.
      int32 page_size = 2;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
      string page_token = 3;
      Specified by:
      getPageToken in interface ListCollectionIdsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListCollectionIdsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListCollectionIdsRequest.Builder setPageToken(String value)
       A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListCollectionIdsRequest.Builder clearPageToken()
       A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListCollectionIdsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • hasReadTime

      public boolean hasReadTime()
       Reads documents as they were 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 = 4;
      Specified by:
      hasReadTime in interface ListCollectionIdsRequestOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       Reads documents as they were 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 = 4;
      Specified by:
      getReadTime in interface ListCollectionIdsRequestOrBuilder
      Returns:
      The readTime.

    • setReadTime

      public ListCollectionIdsRequest.Builder setReadTime(com.google.protobuf.Timestamp value)
       Reads documents as they were 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 = 4;

    • setReadTime

      public ListCollectionIdsRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Reads documents as they were 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 = 4;

    • mergeReadTime

      public ListCollectionIdsRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       Reads documents as they were 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 = 4;

    • clearReadTime

      public ListCollectionIdsRequest.Builder clearReadTime()
       Reads documents as they were 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 = 4;

    • getReadTimeBuilder

      public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
       Reads documents as they were 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 = 4;

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       Reads documents as they were 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 = 4;
      Specified by:
      getReadTimeOrBuilder in interface ListCollectionIdsRequestOrBuilder

    • setUnknownFields

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

    • mergeUnknownFields

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