Package com.google.firestore.admin.v1

Interface ListFieldsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListFieldsRequest, ListFieldsRequest.Builder
@Generated public interface ListFieldsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    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

    • getParent

      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) = { ... }
      Returns:
      The parent.

    • getParentBytes

      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) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      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;
      Returns:
      The filter.

    • getFilterBytes

      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;
      Returns:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       The number of results to return.
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getPageToken

      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;
      Returns:
      The pageToken.

    • getPageTokenBytes

      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;
      Returns:
      The bytes for pageToken.