# Cloud PubSub V1 Client - Class ListTopicSnapshotsRequest (2.19.3)

2.19.3 (latest) 2.19.2 2.18.0 2.17.0 2.16.2 2.15.1 2.14.0 2.13.2 2.12.0 2.11.3 2.10.1 2.9.1 2.8.2 2.7.0 2.6.0 2.5.2 2.4.0 2.3.0 2.2.1 2.1.2 1.50.0 1.49.0 1.48.0 1.47.0 1.46.5 1.45.2 1.44.0 1.43.2 1.42.1 1.41.3 1.40.1 1.39.3 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 PublisherClient::topicName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.ListTopicSnapshotsRequest` |   |