Package com.google.firestore.admin.v1

Class ListFieldsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListFieldsRequest.Builder>
com.google.firestore.admin.v1.ListFieldsRequest.Builder
All Implemented Interfaces:
ListFieldsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListFieldsRequest
public static final class ListFieldsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListFieldsRequest.Builder> implements ListFieldsRequestOrBuilder
 The request for
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
Protobuf type google.firestore.admin.v1.ListFieldsRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    ListFieldsRequest
    build()
     
    ListFieldsRequest
    buildPartial()
     
    ListFieldsRequest.Builder
    clear()
     
    ListFieldsRequest.Builder
    clearFilter()
    The filter to apply to list results.
    ListFieldsRequest.Builder
    clearPageSize()
    The number of results to return.
    ListFieldsRequest.Builder
    clearPageToken()
    A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
    ListFieldsRequest.Builder
    clearParent()
    Required.
    ListFieldsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getFilter()
    The filter to apply to list results.
    com.google.protobuf.ByteString
    getFilterBytes()
    The filter to apply to list results.
    int
    getPageSize()
    The number of results to return.
    String
    getPageToken()
    A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ListFieldsRequest.Builder
    mergeFrom(ListFieldsRequest other)
     
    ListFieldsRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ListFieldsRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ListFieldsRequest.Builder
    setFilter(String value)
    The filter to apply to list results.
    ListFieldsRequest.Builder
    setFilterBytes(com.google.protobuf.ByteString value)
    The filter to apply to list results.
    ListFieldsRequest.Builder
    setPageSize(int value)
    The number of results to return.
    ListFieldsRequest.Builder
    setPageToken(String value)
    A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
    ListFieldsRequest.Builder
    setPageTokenBytes(com.google.protobuf.ByteString value)
    A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
    ListFieldsRequest.Builder
    setParent(String value)
    Required.
    ListFieldsRequest.Builder
    setParentBytes(com.google.protobuf.ByteString value)
    Required.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListFieldsRequest.Builder>

    • clear

      public ListFieldsRequest.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.GeneratedMessage.Builder<ListFieldsRequest.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.GeneratedMessage.Builder<ListFieldsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public ListFieldsRequest.Builder mergeFrom(ListFieldsRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getParent

      public String getParent()
       Required. A parent name of the form
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListFieldsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. A parent name of the form
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListFieldsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListFieldsRequest.Builder setParent(String value)
       Required. A parent name of the form
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListFieldsRequest.Builder clearParent()
       Required. A parent name of the form
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListFieldsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. A parent name of the form
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getFilter

      public String getFilter()
       The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 only supports listing fields that have been explicitly overridden. To issue
 this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 with a filter that includes `indexConfig.usesAncestorConfig:false` or
 `ttlConfig:*`.
      string filter = 2;
      Specified by:
      getFilter in interface ListFieldsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 only supports listing fields that have been explicitly overridden. To issue
 this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 with a filter that includes `indexConfig.usesAncestorConfig:false` or
 `ttlConfig:*`.
      string filter = 2;
      Specified by:
      getFilterBytes in interface ListFieldsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListFieldsRequest.Builder setFilter(String value)
       The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 only supports listing fields that have been explicitly overridden. To issue
 this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 with a filter that includes `indexConfig.usesAncestorConfig:false` or
 `ttlConfig:*`.
      string filter = 2;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListFieldsRequest.Builder clearFilter()
       The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 only supports listing fields that have been explicitly overridden. To issue
 this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 with a filter that includes `indexConfig.usesAncestorConfig:false` or
 `ttlConfig:*`.
      string filter = 2;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public ListFieldsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       The filter to apply to list results. Currently,
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 only supports listing fields that have been explicitly overridden. To issue
 this query, call
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]
 with a filter that includes `indexConfig.usesAncestorConfig:false` or
 `ttlConfig:*`.
      string filter = 2;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getPageSize

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

    • setPageSize

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

    • clearPageSize

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

    • getPageToken

      public String getPageToken()
       A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields],
 that may be used to get the next page of results.
      string page_token = 4;
      Specified by:
      getPageToken in interface ListFieldsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields],
 that may be used to get the next page of results.
      string page_token = 4;
      Specified by:
      getPageTokenBytes in interface ListFieldsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListFieldsRequest.Builder setPageToken(String value)
       A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields],
 that may be used to get the next page of results.
      string page_token = 4;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListFieldsRequest.Builder clearPageToken()
       A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields],
 that may be used to get the next page of results.
      string page_token = 4;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListFieldsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token, returned from a previous call to
 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields],
 that may be used to get the next page of results.
      string page_token = 4;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.