Class: Google::Cloud::PubSub::V1::Topic

Inherits:
Object
  • Object
show all
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

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/*.

Returns:

  • (::String) —

    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/*.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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_retention_duration ⇒ ::Google::Protobuf::Duration

Returns Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 7 days or less than 10 minutes.

Returns:

  • (::Google::Protobuf::Duration) —

    Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 7 days or less than 10 minutes.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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".

Returns:

  • (::String) —

    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".



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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.

Returns:

  • (::Boolean) —

    Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 93

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