Class: OCI::Core::Models::Byoasn

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/byoasn.rb

Overview

Oracle offers the ability to Bring Your Own Autonomous System Number (BYOASN), importing AS Numbers you currently own to Oracle Cloud Infrastructure. A Byoasn resource is a record of the imported AS Number and also some associated metadata. The process used to Bring Your Own ASN is explained in the documentation.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ Byoasn

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

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

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

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

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #id property

  • :asn (Integer) —

    The value to assign to the #asn property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_validated (DateTime) —

    The value to assign to the #time_validated property

  • :validation_token (String) —

    The value to assign to the #validation_token property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :byoip_ranges (Array<OCI::Core::Models::ByoasnByoipRange>) —

    The value to assign to the #byoip_ranges property



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/core/models/byoasn.rb', line 147

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

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

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

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

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

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

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

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

  self.validation_token = attributes[:'validationToken'] if attributes[:'validationToken']

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

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

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

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

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

  self.byoip_ranges = attributes[:'byoipRanges'] if attributes[:'byoipRanges']

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

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

Instance Attribute Details

#asn ⇒ Integer

[Required] The Autonomous System Number (ASN) you are importing to the Oracle cloud.

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/core/models/byoasn.rb', line 53

def asn
  @asn
end

#byoip_ranges ⇒ Array<OCI::Core::Models::ByoasnByoipRange>

The BYOIP Ranges that has the Byoasn as origin.

Returns:



87
88
89
 
# File 'lib/oci/core/models/byoasn.rb', line 87

def byoip_ranges
  @byoip_ranges
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Byoasn resource.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/core/models/byoasn.rb', line 58

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


31
32
33
 
# File 'lib/oci/core/models/byoasn.rb', line 31

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/byoasn.rb', line 37

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


45
46
47
 
# File 'lib/oci/core/models/byoasn.rb', line 45

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Byoasn resource.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/core/models/byoasn.rb', line 49

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The Byoasn resource's current state.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/byoasn.rb', line 23

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

[Required] The date and time the Byoasn resource was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/core/models/byoasn.rb', line 76

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the Byoasn resource was last updated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/core/models/byoasn.rb', line 83

def time_updated
  @time_updated
end

#time_validated ⇒ DateTime

The date and time the Byoasn resource was validated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/core/models/byoasn.rb', line 65

def time_validated
  @time_validated
end

#validation_token ⇒ String

[Required] The validation token is an internally-generated ASCII string used in the validation process. See Importing a Byoasn for details.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/core/models/byoasn.rb', line 69

def validation_token
  @validation_token
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'lifecycle_state': :'lifecycleState',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'asn': :'asn',
    'compartment_id': :'compartmentId',
    'time_validated': :'timeValidated',
    'validation_token': :'validationToken',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'byoip_ranges': :'byoipRanges'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/core/models/byoasn.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'lifecycle_state': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'asn': :'Integer',
    'compartment_id': :'String',
    'time_validated': :'DateTime',
    'validation_token': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'byoip_ranges': :'Array<OCI::Core::Models::ByoasnByoipRange>'
    # 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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/core/models/byoasn.rb', line 238

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

  self.class == other.class &&
    lifecycle_state == other.lifecycle_state &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    asn == other.asn &&
    compartment_id == other.compartment_id &&
    time_validated == other.time_validated &&
    validation_token == other.validation_token &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    byoip_ranges == other.byoip_ranges
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/core/models/byoasn.rb', line 279

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


259
260
261
 
# File 'lib/oci/core/models/byoasn.rb', line 259

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/oci/core/models/byoasn.rb', line 268

def hash
  [lifecycle_state, defined_tags, display_name, freeform_tags, id, asn, compartment_id, time_validated, validation_token, time_created, time_updated, byoip_ranges].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/core/models/byoasn.rb', line 312

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



306
307
308
 
# File 'lib/oci/core/models/byoasn.rb', line 306

def to_s
  to_hash.to_s
end