Class: Google::Apis::PubsubV1::Topic

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

A topic resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Topic

Returns a new instance of Topic.



1767
1768
1769
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1767

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#kms_key_name ⇒ String

Optional. 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/*. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


1721
1722
1723
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1721

def kms_key_name
  @kms_key_name
end

#labels ⇒ Hash<String,String>

Optional. See Creating and managing labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1727
1728
1729
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1727

def labels
  @labels
end

#message_retention_duration ⇒ String

Optional. 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 31 days or less than 10 minutes. Corresponds to the JSON property messageRetentionDuration

Returns:

  • (String) 


1739
1740
1741
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1739

def message_retention_duration
  @message_retention_duration
end

#message_storage_policy ⇒ Google::Apis::PubsubV1::MessageStoragePolicy

A policy constraining the storage of messages published to the topic. Corresponds to the JSON property messageStoragePolicy

Returns:



1744
1745
1746
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1744

def message_storage_policy
  @message_storage_policy
end

#name ⇒ 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". Corresponds to the JSON property name

Returns:

  • (String) 


1753
1754
1755
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1753

def name
  @name
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


1759
1760
1761
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1759

def satisfies_pzs
  @satisfies_pzs
end

#schema_settings ⇒ Google::Apis::PubsubV1::SchemaSettings

Settings for validating messages published against a schema. Corresponds to the JSON property schemaSettings

Returns:



1765
1766
1767
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1765

def schema_settings
  @schema_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1772
1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1772

def update!(**args)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @labels = args[:labels] if args.key?(:labels)
  @message_retention_duration = args[:message_retention_duration] if args.key?(:message_retention_duration)
  @message_storage_policy = args[:message_storage_policy] if args.key?(:message_storage_policy)
  @name = args[:name] if args.key?(:name)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @schema_settings = args[:schema_settings] if args.key?(:schema_settings)
end