Class: OCI::Core::Models::VirtualCircuitPublicPrefix

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

Overview

A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connection. For more information, see FastConnect Overview.

Constant Summary collapse

VERIFICATION_STATE_ENUM =
[
  VERIFICATION_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  VERIFICATION_STATE_COMPLETED = 'COMPLETED'.freeze,
  VERIFICATION_STATE_FAILED = 'FAILED'.freeze,
  VERIFICATION_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 = {}) ⇒ VirtualCircuitPublicPrefix

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cidr_block (String)

    The value to assign to the #cidr_block property

  • :verification_state (String)

    The value to assign to the #verification_state property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 62

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

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

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

Instance Attribute Details

#cidr_blockString

[Required] Publix IP prefix (CIDR) that the customer specified.

Returns:

  • (String)


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

def cidr_block
  @cidr_block
end

#verification_stateString

[Required] Oracle must verify that the customer owns the public IP prefix before traffic for that prefix can flow across the virtual circuit. Verification can take a few business days. IN_PROGRESS means Oracle is verifying the prefix. COMPLETED means verification succeeded. FAILED means verification failed and traffic for this prefix will not flow across the connection.

Returns:

  • (String)


32
33
34
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 32

def verification_state
  @verification_state
end

Class Method Details

.attribute_mapObject

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



35
36
37
38
39
40
41
42
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'cidrBlock',
    'verification_state': :'verificationState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'String',
    'verification_state': :'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



101
102
103
104
105
106
107
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 101

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

  self.class == other.class &&
    cidr_block == other.cidr_block &&
    verification_state == other.verification_state
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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 132

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


112
113
114
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 112

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



121
122
123
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 121

def hash
  [cidr_block, verification_state].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 165

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



159
160
161
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 159

def to_s
  to_hash.to_s
end