Cloud PubSub V1 Client - Class ListSnapshotsRequest (2.5.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class ListSnapshotsRequest.

Request for the ListSnapshots method.

Generated from protobuf message google.pubsub.v1.ListSnapshotsRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ project`	`string` Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`.
`↳ page_size`	`int` Optional. Maximum number of snapshots to return.
`↳ page_token`	`string` Optional. The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data.

getProject

Required. The name of the project in which to list snapshots.

Format is projects/{project-id}.

Returns
Type	Description
`string`

setProject

Required. The name of the project in which to list snapshots.

Format is projects/{project-id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. Maximum number of snapshots to return.

Returns
Type	Description
`int`

setPageSize

Optional. Maximum number of snapshots to return.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

Returns
Type	Description
`string`

setPageToken

Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`project`	`string` Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`. Please see Google\Cloud\PubSub\V1\SubscriberClient::projectName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\PubSub\V1\ListSnapshotsRequest`