Class: OCI::Ons::Models::NotificationTopic

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ons/models/notification_topic.rb

Overview

The properties that define a topic. For general information about topics, see Notifications Overview.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NotificationTopic

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :topic_id (String) —

    The value to assign to the #topic_id property

  • :short_topic_id (String) —

    The value to assign to the #short_topic_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :description (String) —

    The value to assign to the #description property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :etag (String) —

    The value to assign to the #etag property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :api_endpoint (String) —

    The value to assign to the #api_endpoint property



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/ons/models/notification_topic.rb', line 132

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.name = attributes[:'name'] if attributes[:'name']

  self.topic_id = attributes[:'topicId'] if attributes[:'topicId']

  raise 'You cannot provide both :topicId and :topic_id' if attributes.key?(:'topicId') && attributes.key?(:'topic_id')

  self.topic_id = attributes[:'topic_id'] if attributes[:'topic_id']

  self.short_topic_id = attributes[:'shortTopicId'] if attributes[:'shortTopicId']

  raise 'You cannot provide both :shortTopicId and :short_topic_id' if attributes.key?(:'shortTopicId') && attributes.key?(:'short_topic_id')

  self.short_topic_id = attributes[:'short_topic_id'] if attributes[:'short_topic_id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.description = attributes[:'description'] if attributes[:'description']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.etag = attributes[:'etag'] if attributes[:'etag']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.api_endpoint = attributes[:'apiEndpoint'] if attributes[:'apiEndpoint']

  raise 'You cannot provide both :apiEndpoint and :api_endpoint' if attributes.key?(:'apiEndpoint') && attributes.key?(:'api_endpoint')

  self.api_endpoint = attributes[:'api_endpoint'] if attributes[:'api_endpoint']
end

Instance Attribute Details

#api_endpoint ⇒ String

[Required] The endpoint for managing subscriptions or publishing messages to the topic.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/ons/models/notification_topic.rb', line 75

def api_endpoint
  @api_endpoint
end

#compartment_id ⇒ String

[Required] The OCID of the compartment for the topic.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/ons/models/notification_topic.rb', line 38

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


70
71
72
 
# File 'lib/oci/ons/models/notification_topic.rb', line 70

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the topic.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/ons/models/notification_topic.rb', line 47

def description
  @description
end

#etag ⇒ String

For optimistic concurrency control. See if-match.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/ons/models/notification_topic.rb', line 56

def etag
  @etag
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


63
64
65
 
# File 'lib/oci/ons/models/notification_topic.rb', line 63

def freeform_tags
  @freeform_tags
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the topic.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/ons/models/notification_topic.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the topic.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/ons/models/notification_topic.rb', line 23

def name
  @name
end

#short_topic_id ⇒ String

A unique short topic Id. This is used only for SMS subscriptions.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/ons/models/notification_topic.rb', line 33

def short_topic_id
  @short_topic_id
end

#time_created ⇒ DateTime

[Required] The time the topic was created.

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/ons/models/notification_topic.rb', line 51

def time_created
  @time_created
end

#topic_id ⇒ String

[Required] The OCID of the topic.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ons/models/notification_topic.rb', line 28

def topic_id
  @topic_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/ons/models/notification_topic.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'topic_id': :'topicId',
    'short_topic_id': :'shortTopicId',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'description': :'description',
    'time_created': :'timeCreated',
    'etag': :'etag',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'api_endpoint': :'apiEndpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/ons/models/notification_topic.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'topic_id': :'String',
    'short_topic_id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'etag': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'api_endpoint': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/ons/models/notification_topic.rb', line 213

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    topic_id == other.topic_id &&
    short_topic_id == other.short_topic_id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    description == other.description &&
    time_created == other.time_created &&
    etag == other.etag &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    api_endpoint == other.api_endpoint
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/ons/models/notification_topic.rb', line 253

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


233
234
235
 
# File 'lib/oci/ons/models/notification_topic.rb', line 233

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/oci/ons/models/notification_topic.rb', line 242

def hash
  [name, topic_id, short_topic_id, compartment_id, lifecycle_state, description, time_created, etag, freeform_tags, defined_tags, api_endpoint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/ons/models/notification_topic.rb', line 286

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



280
281
282
 
# File 'lib/oci/ons/models/notification_topic.rb', line 280

def to_s
  to_hash.to_s
end