Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest.
Request for the ListTopicSnapshots method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#page_size
defpage_size()->::Integer
Returns
(::Integer) โ Optional. Maximum number of snapshot names to return.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) โ Optional. Maximum number of snapshot names to return.
Returns
(::Integer) โ Optional. Maximum number of snapshot names to return.
#page_token
defpage_token()->::String
Returns
(::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.
#page_token=
defpage_token=(value)->::String
Parameter
value (::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.
Returns
(::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.
#topic
deftopic()->::String
Returns
(::String) โ Required. The name of the topic that snapshots are attached to.
Format is projects/{project}/topics/{topic}.
#topic=
deftopic=(value)->::String
Parameter
value (::String) โ Required. The name of the topic that snapshots are attached to.
Format is projects/{project}/topics/{topic}.
Returns
(::String) โ Required. The name of the topic that snapshots are attached to.
Format is projects/{project}/topics/{topic}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest (v1.11.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.11.1 (latest)](/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.11.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.11.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.10.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.10.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.9.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.9.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.8.2](/ruby/docs/reference/google-cloud-pubsub-v1/1.8.2/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.7.1](/ruby/docs/reference/google-cloud-pubsub-v1/1.7.1/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.6.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.5.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.5.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.4.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.3.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.2.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.1.2](/ruby/docs/reference/google-cloud-pubsub-v1/1.1.2/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [1.0.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.0.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.25.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.25.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.24.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.24.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.23.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.23.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.22.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.22.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.21.2](/ruby/docs/reference/google-cloud-pubsub-v1/0.21.2/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.20.2](/ruby/docs/reference/google-cloud-pubsub-v1/0.20.2/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.19.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.19.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.18.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.18.1/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.17.4](/ruby/docs/reference/google-cloud-pubsub-v1/0.17.4/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.16.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.15.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.15.1/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.14.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.13.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.13.1/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.12.1/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.11.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.10.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.9.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.8.0/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.7.1/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest)\n- [0.6.2](/ruby/docs/reference/google-cloud-pubsub-v1/0.6.2/Google-Cloud-PubSub-V1-ListTopicSnapshotsRequest) \nReference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest.\n\nRequest for the `ListTopicSnapshots` method. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Optional. Maximum number of snapshot names to return.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Optional. Maximum number of snapshot names to return. \n**Returns**\n\n- (::Integer) --- Optional. Maximum number of snapshot names to return.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #topic\n\n def topic() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.\n\n### #topic=\n\n def topic=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`. \n**Returns**\n\n- (::String) --- Required. The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`."]]