class OCI::Core::Models::ByoipRange

Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP 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](docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm) is explained in the documentation.

Constants

LIFECYCLE_DETAILS_ENUM
LIFECYCLE_STATE_ENUM

Attributes

cidr_block[RW]

[Required] The public IPv4 CIDR block being imported from on-premises to the Oracle cloud. @return [String]

compartment_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block.

@return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

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

@return [Hash<String, Hash<String, Object>>]

display_name[RW]

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

@return [String]

freeform_tags[RW]

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/iaas/Content/General/Concepts/resourcetags.htm).

Example: `{"Department": "Finance"}`

@return [Hash<String, String>]

id[RW]

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource. @return [String]

lifecycle_details[R]

The `ByoipRange` resource's current status. @return [String]

lifecycle_state[R]

[Required] The `ByoipRange` resource's current state. @return [String]

time_advertised[RW]

The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

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

@return [DateTime]

time_created[RW]

[Required] The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

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

@return [DateTime]

time_validated[RW]

The date and time the `ByoipRange` resource was validated, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

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

@return [DateTime]

time_withdrawn[RW]

The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

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

@return [DateTime]

validation_token[RW]

[Required] The validation token is an internally-generated ASCII string used in the validation process. See [Importing a CIDR block](docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/byoip_range.rb, line 110
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'cidrBlock',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    '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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :cidr_block The value to assign to the {#cidr_block} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :lifecycle_details The value to assign to the {#lifecycle_details} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_validated The value to assign to the {#time_validated} property @option attributes [DateTime] :time_advertised The value to assign to the {#time_advertised} property @option attributes [DateTime] :time_withdrawn The value to assign to the {#time_withdrawn} property @option attributes [String] :validation_token The value to assign to the {#validation_token} property

# File lib/oci/core/models/byoip_range.rb, line 170
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.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.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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/byoip_range.rb, line 131
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/core/models/byoip_range.rb, line 284
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    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 &&
    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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/core/models/byoip_range.rb, line 326
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/core/models/byoip_range.rb, line 306
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/core/models/byoip_range.rb, line 315
def hash
  [cidr_block, compartment_id, defined_tags, display_name, freeform_tags, id, lifecycle_details, lifecycle_state, time_created, time_validated, time_advertised, time_withdrawn, validation_token].hash
end
lifecycle_details=(lifecycle_details) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_details Object to be assigned

# File lib/oci/core/models/byoip_range.rb, line 255
def lifecycle_details=(lifecycle_details)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_details && !LIFECYCLE_DETAILS_ENUM.include?(lifecycle_details)
    OCI.logger.debug("Unknown value for 'lifecycle_details' [" + lifecycle_details + "]. Mapping to 'LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_details = LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_details = lifecycle_details
  end
  # rubocop:enable Style/ConditionalAssignment
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/core/models/byoip_range.rb, line 268
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/core/models/byoip_range.rb, line 359
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/core/models/byoip_range.rb, line 353
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/core/models/byoip_range.rb, line 376
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end