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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

Constant Summary collapse

VERIFICATION_STATE_ENUM = 
[VERIFICATION_STATE_IN_PROGRESS = 'IN_PROGRESS',
VERIFICATION_STATE_COMPLETED = 'COMPLETED',
VERIFICATION_STATE_FAILED = 'FAILED',
VERIFICATION_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute 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



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 35

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}

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

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

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

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

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

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

end

Instance Attribute Details

#cidr_block ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 19

def cidr_block
  @cidr_block
end

#verification_state ⇒ String

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


28
29
30
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 28

def verification_state
  @verification_state
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



75
76
77
78
79
80
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 75

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      cidr_block == other_object.cidr_block &&
      verification_state == other_object.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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 97

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



90
91
92
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 90

def hash
  [cidr_block, verification_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/core/models/virtual_circuit_public_prefix.rb', line 122

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



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

def to_s
  to_hash.to_s
end