Send feedback
Class CreateSnapshotRequest (2.31.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
CreateSnapshotRequest ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
Request for the CreateSnapshot
method.
Attributes
Name
Description
name
:noindex:
str
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 the `resource name
rules
subscription
:noindex:
str
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 the CreateSnapshot
request; as
well as: (b) Any messages published to the subscription's
topic following the successful completion of the
CreateSnapshot request. Format is
projects/{project}/subscriptions/{sub}
.
labels
:noindex:
MutableMapping[str, str]
Optional. See `Creating and managing
labels
Classes
LabelsEntry
LabelsEntry ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
The abstract base class for a message.
Parameters
Name
Description
kwargs
dict
Keys and values corresponding to the fields of the message.
mapping
Union[dict, .Message
]
A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if mapping
is a mapping type or there are keyword parameters.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
Need to tell us more?
[[["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,["# Class CreateSnapshotRequest (2.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.0 (latest)](/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.30.0](/python/docs/reference/pubsub/2.30.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.29.1](/python/docs/reference/pubsub/2.29.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.28.0](/python/docs/reference/pubsub/2.28.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.27.3](/python/docs/reference/pubsub/2.27.3/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.26.1](/python/docs/reference/pubsub/2.26.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.25.2](/python/docs/reference/pubsub/2.25.2/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.23.1](/python/docs/reference/pubsub/2.23.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.22.0](/python/docs/reference/pubsub/2.22.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.21.5](/python/docs/reference/pubsub/2.21.5/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.20.3](/python/docs/reference/pubsub/2.20.3/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.19.8](/python/docs/reference/pubsub/2.19.8/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.18.4](/python/docs/reference/pubsub/2.18.4/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.17.1](/python/docs/reference/pubsub/2.17.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.16.1](/python/docs/reference/pubsub/2.16.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.15.2](/python/docs/reference/pubsub/2.15.2/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.14.1](/python/docs/reference/pubsub/2.14.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.13.12](/python/docs/reference/pubsub/2.13.12/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.12.1](/python/docs/reference/pubsub/2.12.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.11.1](/python/docs/reference/pubsub/2.11.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.10.0](/python/docs/reference/pubsub/2.10.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.9.0](/python/docs/reference/pubsub/2.9.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.8.0](/python/docs/reference/pubsub/2.8.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.7.1](/python/docs/reference/pubsub/2.7.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.6.1](/python/docs/reference/pubsub/2.6.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.5.0](/python/docs/reference/pubsub/2.5.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.4.2](/python/docs/reference/pubsub/2.4.2/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.3.0](/python/docs/reference/pubsub/2.3.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.2.0](/python/docs/reference/pubsub/2.2.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.1.0](/python/docs/reference/pubsub/2.1.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [2.0.0](/python/docs/reference/pubsub/2.0.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.7.2](/python/docs/reference/pubsub/1.7.2/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.6.1](/python/docs/reference/pubsub/1.6.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.5.0](/python/docs/reference/pubsub/1.5.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.4.3](/python/docs/reference/pubsub/1.4.3/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.3.1](/python/docs/reference/pubsub/1.3.1/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.2.0](/python/docs/reference/pubsub/1.2.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.1.0](/python/docs/reference/pubsub/1.1.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [1.0.2](/python/docs/reference/pubsub/1.0.2/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [0.45.0](/python/docs/reference/pubsub/0.45.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [0.44.0](/python/docs/reference/pubsub/0.44.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest)\n- [0.43.0](/python/docs/reference/pubsub/0.43.0/google.cloud.pubsub_v1.types.CreateSnapshotRequest) \n\n CreateSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRequest for the `CreateSnapshot` method.\n\nClasses\n-------\n\n### LabelsEntry\n\n LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message."]]