Reference documentation and code samples for the Cloud PubSub V1 Client class ListSnapshotsRequest.
Request for theListSnapshotsmethod.
Generated from protobuf messagegoogle.pubsub.v1.ListSnapshotsRequest
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ project
string
Required. The name of the project in which to list snapshots. Format isprojects/{project-id}.
↳ page_size
int
Optional. Maximum number of snapshots to return.
↳ page_token
string
Optional. The value returned by the lastListSnapshotsResponse; indicates that this is a continuation of a priorListSnapshotscall, and that the system should return the next page of data.
getProject
Required. The name of the project in which to list snapshots.
Format isprojects/{project-id}.
Returns
Type
Description
string
setProject
Required. The name of the project in which to list snapshots.
Format isprojects/{project-id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Maximum number of snapshots to return.
Returns
Type
Description
int
setPageSize
Optional. Maximum number of snapshots to return.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. The value returned by the lastListSnapshotsResponse; indicates
that this is a continuation of a priorListSnapshotscall, and that the
system should return the next page of data.
Returns
Type
Description
string
setPageToken
Optional. The value returned by the lastListSnapshotsResponse; indicates
that this is a continuation of a priorListSnapshotscall, 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
project
string
Required. The name of the project in which to list snapshots.
Format isprojects/{project-id}. Please seeSubscriberClient::projectName()for help formatting this field.
[[["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-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class ListSnapshotsRequest (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.ListSnapshotsRequest)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.ListSnapshotsRequest)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.ListSnapshotsRequest)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.ListSnapshotsRequest)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.ListSnapshotsRequest)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.ListSnapshotsRequest)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.ListSnapshotsRequest)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.ListSnapshotsRequest)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.ListSnapshotsRequest)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.ListSnapshotsRequest)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.ListSnapshotsRequest)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.ListSnapshotsRequest)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.ListSnapshotsRequest)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.ListSnapshotsRequest)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.ListSnapshotsRequest)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.ListSnapshotsRequest)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.ListSnapshotsRequest)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.ListSnapshotsRequest)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.ListSnapshotsRequest)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.ListSnapshotsRequest)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.ListSnapshotsRequest)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.ListSnapshotsRequest)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.ListSnapshotsRequest)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.ListSnapshotsRequest)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.ListSnapshotsRequest)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.ListSnapshotsRequest) \nReference documentation and code samples for the Cloud PubSub V1 Client class ListSnapshotsRequest.\n\nRequest for the `ListSnapshots` method.\n\nGenerated from protobuf message `google.pubsub.v1.ListSnapshotsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProject\n\nRequired. The name of the project in which to list snapshots.\n\nFormat is `projects/{project-id}`.\n\n### setProject\n\nRequired. The name of the project in which to list snapshots.\n\nFormat is `projects/{project-id}`.\n\n### getPageSize\n\nOptional. Maximum number of snapshots to return.\n\n### setPageSize\n\nOptional. Maximum number of snapshots to return.\n\n### getPageToken\n\nOptional. The value returned by the last `ListSnapshotsResponse`; indicates\nthat this is a continuation of a prior `ListSnapshots` call, and that the\nsystem should return the next page of data.\n\n### setPageToken\n\nOptional. The value returned by the last `ListSnapshotsResponse`; indicates\nthat this is a continuation of a prior `ListSnapshots` call, and that the\nsystem should return the next page of data.\n\n### static::build"]]
