Cloud PubSub V1 Client - Class ListTopicSnapshotsRequest (1.43.2)

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

Maximum number of snapshot names to return.

↳ page_token string

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

setTopic

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Maximum number of snapshot names to return.

Returns
TypeDescription
int

setPageSize

Maximum number of snapshot names to return.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

setPageToken

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

static::build

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