Reference documentation and code samples for the Cloud PubSub V1 Client class GetSnapshotRequest.
Request for the GetSnapshot method.
Generated from protobuf messagegoogle.pubsub.v1.GetSnapshotRequest
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ snapshot
string
Required. The name of the snapshot to get. Format isprojects/{project}/snapshots/{snap}.
getSnapshot
Required. The name of the snapshot to get.
Format isprojects/{project}/snapshots/{snap}.
Returns
Type
Description
string
setSnapshot
Required. The name of the snapshot to get.
Format isprojects/{project}/snapshots/{snap}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
snapshot
string
Required. The name of the snapshot to get.
Format isprojects/{project}/snapshots/{snap}. Please seeSubscriberClient::snapshotName()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 GetSnapshotRequest (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.GetSnapshotRequest)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.GetSnapshotRequest)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.GetSnapshotRequest)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.GetSnapshotRequest)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.GetSnapshotRequest)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.GetSnapshotRequest)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.GetSnapshotRequest)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.GetSnapshotRequest)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.GetSnapshotRequest)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.GetSnapshotRequest)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.GetSnapshotRequest)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.GetSnapshotRequest)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.GetSnapshotRequest)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.GetSnapshotRequest)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.GetSnapshotRequest)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.GetSnapshotRequest)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.GetSnapshotRequest)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.GetSnapshotRequest)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.GetSnapshotRequest)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.GetSnapshotRequest)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.GetSnapshotRequest)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.GetSnapshotRequest)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.GetSnapshotRequest)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.GetSnapshotRequest)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.GetSnapshotRequest)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.GetSnapshotRequest) \nReference documentation and code samples for the Cloud PubSub V1 Client class GetSnapshotRequest.\n\nRequest for the GetSnapshot method.\n\nGenerated from protobuf message `google.pubsub.v1.GetSnapshotRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSnapshot\n\nRequired. The name of the snapshot to get.\n\nFormat is `projects/{project}/snapshots/{snap}`.\n\n### setSnapshot\n\nRequired. The name of the snapshot to get.\n\nFormat is `projects/{project}/snapshots/{snap}`.\n\n### static::build"]]
