Class: Google::Firestore::Admin::V1::ListFieldsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb

Overview

The request for FirestoreAdmin::ListFields.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns The filter to apply to list results. Currently, FirestoreAdmin::ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin::ListFields with the filter set to indexConfig.usesAncestorConfig:false.

Returns:

  • (String) —

    The filter to apply to list results. Currently, FirestoreAdmin::ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin::ListFields with the filter set to indexConfig.usesAncestorConfig:false.



109
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 109

class ListFieldsRequest; end

#page_size ⇒ Integer

Returns The number of results to return.

Returns:

  • (Integer) —

    The number of results to return.



109
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 109

class ListFieldsRequest; end

#page_token ⇒ String

Returns A page token, returned from a previous call to FirestoreAdmin::ListFields, that may be used to get the next page of results.

Returns:

  • (String) —

    A page token, returned from a previous call to FirestoreAdmin::ListFields, that may be used to get the next page of results.



109
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 109

class ListFieldsRequest; end

#parent ⇒ String

Returns Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}.

Returns:

  • (String) —

    Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}



109
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 109

class ListFieldsRequest; end