Class: Google::Cloud::PubSub::V1::CreateSnapshotRequest
- Inherits:
-
Object
- Object
- Google::Cloud::PubSub::V1::CreateSnapshotRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/pubsub/v1/pubsub.rb
Overview
Request for the CreateSnapshot
method.
Defined Under Namespace
Classes: LabelsEntry
Instance Attribute Summary collapse
- #labels ⇒ ::Google::Protobuf::Map{::String => ::String}
-
#name ⇒ ::String
Required.
-
#subscription ⇒ ::String
Required.
Instance Attribute Details
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns See Creating and managing labels.
913 914 915 916 917 918 919 920 921 922 923 924 925 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 913 class CreateSnapshotRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#name ⇒ ::String
Returns 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. Format is projects/{project}/snapshots/{snap}
.
913 914 915 916 917 918 919 920 921 922 923 924 925 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 913 class CreateSnapshotRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#subscription ⇒ ::String
Returns 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}
.
913 914 915 916 917 918 919 920 921 922 923 924 925 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 913 class CreateSnapshotRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |