Cloud Firestore V1 Client - Class ListCollectionIdsRequest (1.39.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

Namespace

Google \ Cloud \ Firestore \ V1

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 .

↳ read_time
Google\Protobuf\Timestamp

Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

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 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReadTime

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Returns
Type
Description

hasReadTime

setReadTime

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Parameter
Name
Description
Returns
Type
Description
$this

getConsistencySelector

Returns
Type
Description
string

static::build

Parameter
Name
Description
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

Design a Mobile Site
View Site in Mobile | Classic
Share by: