Cloud PubSub V1 Client - Class ListTopicSnapshotsRequest (2.3.0)

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

Request for the ListTopicSnapshots method.

Generated from protobuf message google.pubsub.v1.ListTopicSnapshotsRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ topic string

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.
↳ page_size int

Optional. Maximum number of snapshot names to return.
↳ page_token string

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

getTopic

Required. The name of the topic that snapshots are attached to.

Format is projects/{project}/topics/{topic}.

Returns
Type Description
string

setTopic

Required. The name of the topic that snapshots are attached to.

Format is projects/{project}/topics/{topic}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Maximum number of snapshot names to return.

Returns
Type Description
int

setPageSize

Optional. Maximum number of snapshot names to return.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

Optional. The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots 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
topic string

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}. Please see Google\Cloud\PubSub\V1\PublisherClient::topicName() for help formatting this field.
Returns
Type Description
Google\Cloud\PubSub\V1\ListTopicSnapshotsRequest