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
Namespace
Google \ Cloud \ Firestore \ Admin \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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 or ttlConfig:*.
↳ 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
Type
Description
string
setParent
Required. A parent name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$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 or
ttlConfig:*.
Returns
Type
Description
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 or
ttlConfig:*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The number of results to return.
Returns
Type
Description
int
setPageSize
The number of results to return.
Parameter
Name
Description
var
int
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. A parent name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
Please see FirestoreAdminClient::collectionGroupName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class ListFieldsRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.ListFieldsRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.ListFieldsRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.ListFieldsRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.ListFieldsRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.ListFieldsRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.ListFieldsRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.ListFieldsRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.ListFieldsRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.ListFieldsRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.ListFieldsRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.ListFieldsRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.ListFieldsRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.ListFieldsRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.ListFieldsRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.ListFieldsRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.ListFieldsRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.ListFieldsRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.ListFieldsRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.ListFieldsRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.ListFieldsRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.ListFieldsRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.ListFieldsRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.ListFieldsRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class ListFieldsRequest.\n\nThe request for\nFirestoreAdmin.ListFields.\n\nGenerated from protobuf message `google.firestore.admin.v1.ListFieldsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. A parent name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`\n\n### setParent\n\nRequired. A parent name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`\n\n### getFilter\n\nThe filter to apply to list results. Currently,\nFirestoreAdmin.ListFields\nonly supports listing fields that have been explicitly overridden. To issue\nthis query, call\nFirestoreAdmin.ListFields\nwith a filter that includes `indexConfig.usesAncestorConfig:false` or\n`ttlConfig:*`.\n\n### setFilter\n\nThe filter to apply to list results. Currently,\nFirestoreAdmin.ListFields\nonly supports listing fields that have been explicitly overridden. To issue\nthis query, call\nFirestoreAdmin.ListFields\nwith a filter that includes `indexConfig.usesAncestorConfig:false` or\n`ttlConfig:*`.\n\n### getPageSize\n\nThe number of results to return.\n\n### setPageSize\n\nThe number of results to return.\n\n### getPageToken\n\nA page token, returned from a previous call to\nFirestoreAdmin.ListFields,\nthat may be used to get the next page of results.\n\n### setPageToken\n\nA page token, returned from a previous call to\nFirestoreAdmin.ListFields,\nthat may be used to get the next page of results.\n\n### static::build"]]
