Class: OCI::Ons::Models::SubscriptionSummary

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

Overview

The subscription’s configuration summary.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =

rubocop:disable Metrics/LineLength

[
  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 = {}) ⇒ SubscriptionSummary

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

  • :created_time (Integer) —

    The value to assign to the #created_time property

  • :delivery_policy (OCI::Ons::Models::DeliveryPolicy) —

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



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
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
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 123

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

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

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

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

#created_time ⇒ Integer

The time when this suscription was created.

Returns:

  • (Integer) 


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

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

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

Returns:

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


69
70
71
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 69

def defined_tags
  @defined_tags
end

#delivery_policy ⇒ OCI::Ons::Models::DeliveryPolicy

Returns:



50
51
52
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 50

def delivery_policy
  @delivery_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) 


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

def endpoint
  @endpoint
end

#etag ⇒ String

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

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 55

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


62
63
64
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 62

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_summary.rb', line 21

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the subscription. Default value for a newly created subscription: PENDING.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#protocol ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 31

def protocol
  @protocol
end

#topic_id ⇒ String

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

Returns:

  • (String) 


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

def topic_id
  @topic_id
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 72

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

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 90

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'topic_id': :'String',
    'protocol': :'String',
    'endpoint': :'String',
    'lifecycle_state': :'String',
    'created_time': :'Integer',
    'delivery_policy': :'OCI::Ons::Models::DeliveryPolicy',
    '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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 196

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 &&
    created_time == other.created_time &&
    delivery_policy == other.delivery_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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 235

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


215
216
217
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 215

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



224
225
226
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 224

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



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 268

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



262
263
264
 
# File 'lib/oci/ons/models/subscription_summary.rb', line 262

def to_s
  to_hash.to_s
end