Reference documentation and code samples for the Cloud Firestore V1beta1 Client class ListCollectionIdsRequest.
The request for Firestore.ListCollectionIds.
Generated from protobuf message google.firestore.v1beta1.ListCollectionIdsRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent document. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
↳ page_size
int
The maximum number of results to return.
↳ page_token
string
A page token. Must be a value from ListCollectionIdsResponse.
getParent
Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
Returns
Type
Description
string
setParent
Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of results to return.
Returns
Type
Description
int
setPageSize
The maximum number of results to return.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A page token. Must be a value from
ListCollectionIdsResponse.
Returns
Type
Description
string
setPageToken
A page token. Must be a value from
ListCollectionIdsResponse.