Reference documentation and code samples for the Cloud PubSub V1 Client class CreateSnapshotRequest.
Request for theCreateSnapshotmethod.
Generated from protobuf messagegoogle.pubsub.v1.CreateSnapshotRequest
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See theresource name rules. Format isprojects/{project}/snapshots/{snap}.
↳ subscription
string
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of theCreateSnapshotrequest; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format isprojects/{project}/subscriptions/{sub}.
Required. User-provided name for this snapshot. If the name is not provided
in the request, the server will assign a random name for this snapshot on
the same project as the subscription. Note that for REST API requests, you
must specify a name. See theresource name
rules.
Format isprojects/{project}/snapshots/{snap}.
Returns
Type
Description
string
setName
Required. User-provided name for this snapshot. If the name is not provided
in the request, the server will assign a random name for this snapshot on
the same project as the subscription. Note that for REST API requests, you
must specify a name. See theresource name
rules.
Format isprojects/{project}/snapshots/{snap}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSubscription
Required. The subscription whose backlog the snapshot retains.
Specifically, the created snapshot is guaranteed to retain:
(a) The existing backlog on the subscription. More precisely, this is
defined as the messages in the subscription's backlog that are
unacknowledged upon the successful completion of theCreateSnapshotrequest; as well as:
(b) Any messages published to the subscription's topic following the
successful completion of the CreateSnapshot request.
Format isprojects/{project}/subscriptions/{sub}.
Returns
Type
Description
string
setSubscription
Required. The subscription whose backlog the snapshot retains.
Specifically, the created snapshot is guaranteed to retain:
(a) The existing backlog on the subscription. More precisely, this is
defined as the messages in the subscription's backlog that are
unacknowledged upon the successful completion of theCreateSnapshotrequest; as well as:
(b) Any messages published to the subscription's topic following the
successful completion of the CreateSnapshot request.
Format isprojects/{project}/subscriptions/{sub}.
Required. User-provided name for this snapshot. If the name is not provided
in the request, the server will assign a random name for this snapshot on
the same project as the subscription. Note that for REST API requests, you
must specify a name. See theresource name
rules.
Format isprojects/{project}/snapshots/{snap}. Please seeSubscriberClient::snapshotName()for help formatting this field.
subscription
string
Required. The subscription whose backlog the snapshot retains.
Specifically, the created snapshot is guaranteed to retain:
(a) The existing backlog on the subscription. More precisely, this is
defined as the messages in the subscription's backlog that are
unacknowledged upon the successful completion of theCreateSnapshotrequest; as well as:
(b) Any messages published to the subscription's topic following the
successful completion of the CreateSnapshot request.
Format isprojects/{project}/subscriptions/{sub}. Please seeSubscriberClient::subscriptionName()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 CreateSnapshotRequest (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.CreateSnapshotRequest)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.CreateSnapshotRequest)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.CreateSnapshotRequest)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.CreateSnapshotRequest)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.CreateSnapshotRequest)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.CreateSnapshotRequest)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.CreateSnapshotRequest)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.CreateSnapshotRequest)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.CreateSnapshotRequest)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.CreateSnapshotRequest)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.CreateSnapshotRequest)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.CreateSnapshotRequest)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.CreateSnapshotRequest)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.CreateSnapshotRequest)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.CreateSnapshotRequest)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.CreateSnapshotRequest)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.CreateSnapshotRequest)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.CreateSnapshotRequest)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.CreateSnapshotRequest)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.CreateSnapshotRequest)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.CreateSnapshotRequest)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.CreateSnapshotRequest)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.CreateSnapshotRequest)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.CreateSnapshotRequest)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.CreateSnapshotRequest)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.CreateSnapshotRequest) \nReference documentation and code samples for the Cloud PubSub V1 Client class CreateSnapshotRequest.\n\nRequest for the `CreateSnapshot` method.\n\nGenerated from protobuf message `google.pubsub.v1.CreateSnapshotRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. User-provided name for this snapshot. If the name is not provided\nin the request, the server will assign a random name for this snapshot on\nthe same project as the subscription. Note that for REST API requests, you\nmust specify a name. See the [resource name\nrules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).\n\nFormat is `projects/{project}/snapshots/{snap}`.\n\n### setName\n\nRequired. User-provided name for this snapshot. If the name is not provided\nin the request, the server will assign a random name for this snapshot on\nthe same project as the subscription. Note that for REST API requests, you\nmust specify a name. See the [resource name\nrules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).\n\nFormat is `projects/{project}/snapshots/{snap}`.\n\n### getSubscription\n\nRequired. The subscription whose backlog the snapshot retains.\n\nSpecifically, the created snapshot is guaranteed to retain:\n(a) The existing backlog on the subscription. More precisely, this is\ndefined as the messages in the subscription's backlog that are\nunacknowledged upon the successful completion of the\n`CreateSnapshot` request; as well as:\n(b) Any messages published to the subscription's topic following the\nsuccessful completion of the CreateSnapshot request.\nFormat is `projects/{project}/subscriptions/{sub}`.\n\n### setSubscription\n\nRequired. The subscription whose backlog the snapshot retains.\n\nSpecifically, the created snapshot is guaranteed to retain:\n(a) The existing backlog on the subscription. More precisely, this is\ndefined as the messages in the subscription's backlog that are\nunacknowledged upon the successful completion of the\n`CreateSnapshot` request; as well as:\n(b) Any messages published to the subscription's topic following the\nsuccessful completion of the CreateSnapshot request.\nFormat is `projects/{project}/subscriptions/{sub}`.\n\n### getLabels\n\nOptional. See [Creating and managing\nlabels](https://cloud.google.com/pubsub/docs/labels).\n\n### setLabels\n\nOptional. See [Creating and managing\nlabels](https://cloud.google.com/pubsub/docs/labels).\n\n### static::build"]]
