Cloud Firestore V1 Client - Class ListFieldsRequest (1.33.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class ListFieldsRequest.

The request for FirestoreAdmin.ListFields.

Generated from protobuf message google.firestore.admin.v1.ListFieldsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ filter 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 .

↳ page_size int

The number of results to return.

↳ page_token string

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

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

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 .

Returns
TypeDescription
string

setFilter

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 .

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The number of results to return.

Returns
TypeDescription
int

setPageSize

The number of results to return.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this