Class: OCI::Core::Models::ByoipRange

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

Overview

Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A ByoipRange resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. The process used to Bring Your Own IP is explained in the documentation.

Constant Summary collapse

LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_CREATING = 'CREATING'.freeze,
  LIFECYCLE_DETAILS_VALIDATING = 'VALIDATING'.freeze,
  LIFECYCLE_DETAILS_PROVISIONED = 'PROVISIONED'.freeze,
  LIFECYCLE_DETAILS_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_DETAILS_FAILED = 'FAILED'.freeze,
  LIFECYCLE_DETAILS_DELETING = 'DELETING'.freeze,
  LIFECYCLE_DETAILS_DELETED = 'DELETED'.freeze,
  LIFECYCLE_DETAILS_ADVERTISING = 'ADVERTISING'.freeze,
  LIFECYCLE_DETAILS_WITHDRAWING = 'WITHDRAWING'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.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 = {}) ⇒ ByoipRange

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/core/models/byoip_range.rb', line 189

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

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

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

  self.cidr_block = attributes[:'cidrBlock'] if attributes[:'cidrBlock']

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

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

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

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

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

  self.time_withdrawn = attributes[:'timeWithdrawn'] if attributes[:'timeWithdrawn']

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

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

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

Instance Attribute Details

#byoip_range_vcn_ipv6_allocations ⇒ Array<OCI::Core::Models::ByoipRangeVcnIpv6AllocationSummary>

A list of ByoipRangeVcnIpv6AllocationSummary objects.

Returns:



38
39
40
 
# File 'lib/oci/core/models/byoip_range.rb', line 38

def byoip_range_vcn_ipv6_allocations
  @byoip_range_vcn_ipv6_allocations
end

#cidr_block ⇒ String

The public IPv4 CIDR block being imported from on-premises to the Oracle cloud.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/core/models/byoip_range.rb', line 42

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the BYOIP CIDR block.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/byoip_range.rb', line 47

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


55
56
57
 
# File 'lib/oci/core/models/byoip_range.rb', line 55

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) 


61
62
63
 
# File 'lib/oci/core/models/byoip_range.rb', line 61

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the ByoipRange resource.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/core/models/byoip_range.rb', line 73

def id
  @id
end

#ipv6_cidr_block ⇒ String

The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/core/models/byoip_range.rb', line 80

def ipv6_cidr_block
  @ipv6_cidr_block
end

#lifecycle_details ⇒ String

The ByoipRange resource's current status.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/core/models/byoip_range.rb', line 84

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The ByoipRange resource's current state.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/core/models/byoip_range.rb', line 88

def lifecycle_state
  @lifecycle_state
end

#time_advertised ⇒ DateTime

The date and time the ByoipRange resource was advertised to the internet by BGP, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


109
110
111
 
# File 'lib/oci/core/models/byoip_range.rb', line 109

def time_advertised
  @time_advertised
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


95
96
97
 
# File 'lib/oci/core/models/byoip_range.rb', line 95

def time_created
  @time_created
end

#time_validated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


102
103
104
 
# File 'lib/oci/core/models/byoip_range.rb', line 102

def time_validated
  @time_validated
end

#time_withdrawn ⇒ DateTime

The date and time the ByoipRange resource was withdrawn from advertisement by BGP to the internet, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


116
117
118
 
# File 'lib/oci/core/models/byoip_range.rb', line 116

def time_withdrawn
  @time_withdrawn
end

#validation_token ⇒ String

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

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/core/models/byoip_range.rb', line 120

def validation_token
  @validation_token
end

Class Method Details

.attribute_map ⇒ Object

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/core/models/byoip_range.rb', line 123

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'byoip_range_vcn_ipv6_allocations': :'byoipRangeVcnIpv6Allocations',
    'cidr_block': :'cidrBlock',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'ipv6_cidr_block': :'ipv6CidrBlock',
    'lifecycle_details': :'lifecycleDetails',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_validated': :'timeValidated',
    'time_advertised': :'timeAdvertised',
    'time_withdrawn': :'timeWithdrawn',
    'validation_token': :'validationToken'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/core/models/byoip_range.rb', line 146

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'byoip_range_vcn_ipv6_allocations': :'Array<OCI::Core::Models::ByoipRangeVcnIpv6AllocationSummary>',
    'cidr_block': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'ipv6_cidr_block': :'String',
    'lifecycle_details': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_validated': :'DateTime',
    'time_advertised': :'DateTime',
    'time_withdrawn': :'DateTime',
    'validation_token': :'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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/core/models/byoip_range.rb', line 315

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

  self.class == other.class &&
    byoip_range_vcn_ipv6_allocations == other.byoip_range_vcn_ipv6_allocations &&
    cidr_block == other.cidr_block &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    ipv6_cidr_block == other.ipv6_cidr_block &&
    lifecycle_details == other.lifecycle_details &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_validated == other.time_validated &&
    time_advertised == other.time_advertised &&
    time_withdrawn == other.time_withdrawn &&
    validation_token == other.validation_token
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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/core/models/byoip_range.rb', line 359

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


339
340
341
 
# File 'lib/oci/core/models/byoip_range.rb', line 339

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



348
349
350
 
# File 'lib/oci/core/models/byoip_range.rb', line 348

def hash
  [byoip_range_vcn_ipv6_allocations, cidr_block, compartment_id, defined_tags, display_name, freeform_tags, id, ipv6_cidr_block, lifecycle_details, lifecycle_state, time_created, time_validated, time_advertised, time_withdrawn, validation_token].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
401
 
# File 'lib/oci/core/models/byoip_range.rb', line 392

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



386
387
388
 
# File 'lib/oci/core/models/byoip_range.rb', line 386

def to_s
  to_hash.to_s
end