Cloud Firestore V1 Client - Class ListCollectionIdsRequest (1.31.0)

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

The request for Firestore.ListCollectionIds.

Generated from protobuf message google.firestore.v1.ListCollectionIdsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ read_time Google\Protobuf\Timestamp

Reads documents as they were at the given time. This may not be older than 270 seconds.

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of results to return.

Returns
TypeDescription
int

setPageSize

The maximum number of results to return.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token. Must be a value from ListCollectionIdsResponse.

Returns
TypeDescription
string

setPageToken

A page token. Must be a value from ListCollectionIdsResponse.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadTime

Reads documents as they were at the given time.

This may not be older than 270 seconds.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

setReadTime

Reads documents as they were at the given time.

This may not be older than 270 seconds.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getConsistencySelector

Returns
TypeDescription
string