Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::Topic (v0.12.1)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::Topic.

A topic resource.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_key_name

def kms_key_name() -> ::String
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/*.

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::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/*.

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

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
Returns

#message_retention_duration

def message_retention_duration() -> ::Google::Protobuf::Duration
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.

#message_retention_duration=

def message_retention_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::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.
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.

#message_storage_policy

def message_storage_policy() -> ::Google::Cloud::PubSub::V1::MessageStoragePolicy
Returns

#message_storage_policy=

def message_storage_policy=(value) -> ::Google::Cloud::PubSub::V1::MessageStoragePolicy
Parameter
Returns

#name

def name() -> ::String
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".

#name=

def name=(value) -> ::String
Parameter
  • value (::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".
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".

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
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.

#satisfies_pzs=

def satisfies_pzs=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#schema_settings

def schema_settings() -> ::Google::Cloud::PubSub::V1::SchemaSettings
Returns

#schema_settings=

def schema_settings=(value) -> ::Google::Cloud::PubSub::V1::SchemaSettings
Parameter
Returns