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 \ V1Methods
__construct
Constructor.
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}
string
setParent
Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
var
string
$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
.
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
.
var
string
$this
getPageSize
The number of results to return.
int
setPageSize
The number of results to return.
var
int
$this
getPageToken
A page token, returned from a previous call to FirestoreAdmin.ListFields , that may be used to get the next page of results.
string
setPageToken
A page token, returned from a previous call to FirestoreAdmin.ListFields , that may be used to get the next page of results.
var
string
$this
static::build
parent
string
Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::collectionGroupName()
for help formatting this field.
