Class: OCI::Ons::Models::Subscription

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

Overview

The subscription's configuration. For general information about subscriptions, see Notifications Overview.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PENDING = 'PENDING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ Subscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :topic_id (String) —

    The value to assign to the #topic_id property

  • :protocol (String) —

    The value to assign to the #protocol property

  • :endpoint (String) —

    The value to assign to the #endpoint property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :created_time (Integer) —

    The value to assign to the #created_time property

  • :deliver_policy (String) —

    The value to assign to the #deliver_policy 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



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
192
193
 
# File 'lib/oci/ons/models/subscription.rb', line 136

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.id = attributes[:'id'] if attributes[:'id']

  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.protocol = attributes[:'protocol'] if attributes[:'protocol']

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']
  self.lifecycle_state = "PENDING" if lifecycle_state.nil? && !attributes.key?(:'lifecycleState') # rubocop:disable Style/StringLiterals

  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.lifecycle_state = "PENDING" if lifecycle_state.nil? && !attributes.key?(:'lifecycleState') && !attributes.key?(:'lifecycle_state') # rubocop:disable Style/StringLiterals

  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.created_time = attributes[:'createdTime'] if attributes[:'createdTime']

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

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

  self.deliver_policy = attributes[:'deliverPolicy'] if attributes[:'deliverPolicy']

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

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

  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']
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#created_time ⇒ Integer

The time when this suscription was created.

Returns:

  • (Integer) 


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

def created_time
  @created_time
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>>) 


79
80
81
 
# File 'lib/oci/ons/models/subscription.rb', line 79

def defined_tags
  @defined_tags
end

#deliver_policy ⇒ String

The delivery policy of the subscription. Stored as a JSON string.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/ons/models/subscription.rb', line 60

def deliver_policy
  @deliver_policy
end

#endpoint ⇒ String

[Required] A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/ons/models/subscription.rb', line 41

def endpoint
  @endpoint
end

#etag ⇒ String

For optimistic concurrency control. See if-match.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/ons/models/subscription.rb', line 65

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>) 


72
73
74
 
# File 'lib/oci/ons/models/subscription.rb', line 72

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the subscription.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/ons/models/subscription.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#protocol ⇒ String

[Required] The protocol used for the subscription. For information about subscription protocols, see To create a subscription.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/ons/models/subscription.rb', line 35

def protocol
  @protocol
end

#topic_id ⇒ String

[Required] The OCID of the associated topic.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ons/models/subscription.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.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/ons/models/subscription.rb', line 82

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'topic_id': :'topicId',
    'protocol': :'protocol',
    'endpoint': :'endpoint',
    'lifecycle_state': :'lifecycleState',
    'compartment_id': :'compartmentId',
    'created_time': :'createdTime',
    'deliver_policy': :'deliverPolicy',
    'etag': :'etag',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/ons/models/subscription.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'topic_id': :'String',
    'protocol': :'String',
    'endpoint': :'String',
    'lifecycle_state': :'String',
    'compartment_id': :'String',
    'created_time': :'Integer',
    'deliver_policy': :'String',
    'etag': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



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

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

  self.class == other.class &&
    id == other.id &&
    topic_id == other.topic_id &&
    protocol == other.protocol &&
    endpoint == other.endpoint &&
    lifecycle_state == other.lifecycle_state &&
    compartment_id == other.compartment_id &&
    created_time == other.created_time &&
    deliver_policy == other.deliver_policy &&
    etag == other.etag &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



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

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


235
236
237
 
# File 'lib/oci/ons/models/subscription.rb', line 235

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/oci/ons/models/subscription.rb', line 244

def hash
  [id, topic_id, protocol, endpoint, lifecycle_state, compartment_id, created_time, deliver_policy, etag, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/ons/models/subscription.rb', line 288

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



282
283
284
 
# File 'lib/oci/ons/models/subscription.rb', line 282

def to_s
  to_hash.to_s
end