Class: OCI::Core::Models::ByoipRangeVcnIpv6AllocationSummary

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

Overview

A summary of IPv6 prefix subranges currently allocated to a VCN.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ByoipRangeVcnIpv6AllocationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :byoip_range_id (String) —

    The value to assign to the #byoip_range_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :ipv6_cidr_block (String) —

    The value to assign to the #ipv6_cidr_block property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

[View source]

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 66

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_id = attributes[:'byoipRangeId'] if attributes[:'byoipRangeId']

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

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

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

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

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

Instance Attribute Details

#byoip_range_id ⇒ String

The OCID of the ByoipRange resource to which the CIDR block belongs.

Returns:

  • (String) 

14
15
16
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 14

def byoip_range_id
  @byoip_range_id
end

#compartment_id ⇒ String

The OCID of the compartment containing the ByoipRange.

Returns:

  • (String) 

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

def compartment_id
  @compartment_id
end

#ipv6_cidr_block ⇒ String

The BYOIPv6 prefix range or subrange allocated to a VCN. This could be all or part of a BYOIPv6 prefix. Each VCN allocation must be /64 or larger.

Returns:

  • (String) 

25
26
27
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 25

def ipv6_cidr_block
  @ipv6_cidr_block
end

#vcn_id ⇒ String

The OCID of the Vcn resource to which the ByoipRange belongs.

Returns:

  • (String) 

30
31
32
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 30

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'byoip_range_id': :'byoipRangeId',
    'compartment_id': :'compartmentId',
    'ipv6_cidr_block': :'ipv6CidrBlock',
    'vcn_id': :'vcnId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'byoip_range_id': :'String',
    'compartment_id': :'String',
    'ipv6_cidr_block': :'String',
    'vcn_id': :'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

[View source]

104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 104

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

  self.class == other.class &&
    byoip_range_id == other.byoip_range_id &&
    compartment_id == other.compartment_id &&
    ipv6_cidr_block == other.ipv6_cidr_block &&
    vcn_id == other.vcn_id
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

[View source]

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 137

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
[View source]

117
118
119
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

126
127
128
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 126

def hash
  [byoip_range_id, compartment_id, ipv6_cidr_block, vcn_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 170

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

[View source]

164
165
166
 
# File 'lib/oci/core/models/byoip_range_vcn_ipv6_allocation_summary.rb', line 164

def to_s
  to_hash.to_s
end