Cloud PubSub V1 Client - Class ListSnapshotsRequest (1.43.2)

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

Maximum number of snapshots to return.

↳ page_token string

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
TypeDescription
string

setProject

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

Format is projects/{project-id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Maximum number of snapshots to return.

Returns
TypeDescription
int

setPageSize

Maximum number of snapshots to return.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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
TypeDescription
string

setPageToken

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

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\PubSub\V1\ListSnapshotsRequest