Class: Google::Cloud::PubSub::V1::Topic
- Inherits:
-
Object
- Object
- Google::Cloud::PubSub::V1::Topic
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/pubsub/v1/pubsub.rb
Overview
A topic resource.
Defined Under Namespace
Classes: LabelsEntry
Instance Attribute Summary collapse
-
#kms_key_name ⇒ ::String
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
- #labels ⇒ ::Google::Protobuf::Map{::String => ::String}
-
#message_storage_policy ⇒ ::Google::Cloud::PubSub::V1::MessageStoragePolicy
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
-
#name ⇒ ::String
Required.
-
#satisfies_pzs ⇒ ::Boolean
Reserved for future use.
-
#schema_settings ⇒ ::Google::Cloud::PubSub::V1::SchemaSettings
Settings for validating messages published against a schema.
Instance Attribute Details
#kms_key_name ⇒ ::String
Returns The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*
.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 83 class Topic 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 |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns See Creating and managing labels.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 83 class Topic 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 |
#message_storage_policy ⇒ ::Google::Cloud::PubSub::V1::MessageStoragePolicy
Returns Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 83 class Topic 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. The name of the topic. It must have the format
"projects/{project}/topics/{topic}"
. {topic}
must start with a letter,
and contain only letters ([A-Za-z]
), numbers ([0-9]
), dashes (-
),
underscores (_
), periods (.
), tildes (~
), plus (+
) or percent
signs (%
). It must be between 3 and 255 characters in length, and it
must not start with "goog"
.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 83 class Topic 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 |
#satisfies_pzs ⇒ ::Boolean
Returns Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 83 class Topic 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 |
#schema_settings ⇒ ::Google::Cloud::PubSub::V1::SchemaSettings
Returns Settings for validating messages published against a schema.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 83 class Topic 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 |