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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. A parent name of the form |
↳ 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 |
↳ 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 .
| 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 .
| 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 | |