Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::ListFieldsRequest (v1.2.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::ListFieldsRequest.

The request for FirestoreAdmin.ListFields.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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 a filter that includes indexConfig.usesAncestorConfig:false or ttlConfig:*.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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 a filter that includes indexConfig.usesAncestorConfig:false or ttlConfig:*.
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 a filter that includes indexConfig.usesAncestorConfig:false or ttlConfig:*.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The number of results to return.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of results to return.
Returns
  • (::Integer) — The number of results to return.

#page_token

def page_token() -> ::String
Returns
  • (::String) — A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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}