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

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

Overview

The subscription’s configuration.

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

  • :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

  • :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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/ons/models/subscription.rb', line 108

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

#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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

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


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

def defined_tags
  @defined_tags
end

#deliver_policy ⇒ String

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

Returns:

  • (String) 


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

def deliver_policy
  @deliver_policy
end

#endpoint ⇒ String

[Required] The endpoint of the subscription. Valid values depend on the protocol. For EMAIL, only an email address is valid. For HTTPS, only a PagerDuty URL is valid. A URL cannot exceed 512 characters. Avoid entering confidential information.

Returns:

  • (String) 


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

def endpoint
  @endpoint
end

#etag ⇒ String

For optimistic concurrency control. See ‘if-match`.

Returns:

  • (String) 


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

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


53
54
55
 
# File 'lib/oci/ons/models/subscription.rb', line 53

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/ons/models/subscription.rb', line 21

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the subscription.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ons/models/subscription.rb', line 37

def lifecycle_state
  @lifecycle_state
end

#protocol ⇒ String

[Required] The subscription protocol. Valid values: EMAIL, HTTPS.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ons/models/subscription.rb', line 26

def protocol
  @protocol
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/ons/models/subscription.rb', line 63

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'protocol': :'String',
    'endpoint': :'String',
    'lifecycle_state': :'String',
    '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



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/ons/models/subscription.rb', line 169

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

  self.class == other.class &&
    id == other.id &&
    protocol == other.protocol &&
    endpoint == other.endpoint &&
    lifecycle_state == other.lifecycle_state &&
    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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/ons/models/subscription.rb', line 206

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


186
187
188
 
# File 'lib/oci/ons/models/subscription.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/oci/ons/models/subscription.rb', line 195

def hash
  [id, protocol, endpoint, lifecycle_state, 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



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/ons/models/subscription.rb', line 239

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



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

def to_s
  to_hash.to_s
end