Class: OCI::Multicloud::Models::OciVcn

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/multicloud/models/oci_vcn.rb

Overview

Oracle Cloud Infrastructure VCN basic information object. It is optional and planned to used for future for network anchor

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OciVcn

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :vcn_name (String) —

    The value to assign to the #vcn_name property

  • :cidr_blocks (Array<String>) —

    The value to assign to the #cidr_blocks property

  • :backup_cidr_blocks (Array<String>) —

    The value to assign to the #backup_cidr_blocks property

  • :dns_label (String) —

    The value to assign to the #dns_label property



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 80

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

  self.vcn_name = attributes[:'vcnName'] if attributes[:'vcnName']

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

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

  self.cidr_blocks = attributes[:'cidrBlocks'] if attributes[:'cidrBlocks']

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

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

  self.backup_cidr_blocks = attributes[:'backupCidrBlocks'] if attributes[:'backupCidrBlocks']

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

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

  self.dns_label = attributes[:'dnsLabel'] if attributes[:'dnsLabel']

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

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

Instance Attribute Details

#backup_cidr_blocks ⇒ Array<String>

Oracle Cloud Infrastructure backup cidr block. CSP can set this property It's optional only if disconnect anchor is allowed. IPv4 CIDR blocks for the VCN that meet the following criteria Type: [string (length: 1u201332), …] The CIDR blocks must be valid. They must not overlap with each other or with the on-premises network CIDR block.

Returns:

  • (Array<String>) 


37
38
39
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 37

def backup_cidr_blocks
  @backup_cidr_blocks
end

#cidr_blocks ⇒ Array<String>

Oracle Cloud Infrastructure primary cidr block. CSP can set this property It's optional only if disconnect anchor is allowed IPv4 CIDR blocks for the VCN that meet the following criteria Type: [string (length: 1u201332), …] The CIDR blocks must be valid. They must not overlap with each other or with the on-premises network CIDR block.

Returns:

  • (Array<String>) 


27
28
29
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 27

def cidr_blocks
  @cidr_blocks
end

#dns_label ⇒ String

Oracle Cloud Infrastructure DNS label. This is optional if DNS config is provided.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 41

def dns_label
  @dns_label
end

#vcn_id ⇒ String

Oracle Cloud Infrastructure VCN OCID. CSP can not set this property.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 13

def vcn_id
  @vcn_id
end

#vcn_name ⇒ String

Name of the VCN associated to the Network Anchor.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 17

def vcn_name
  @vcn_name
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vcn_id': :'vcnId',
    'vcn_name': :'vcnName',
    'cidr_blocks': :'cidrBlocks',
    'backup_cidr_blocks': :'backupCidrBlocks',
    'dns_label': :'dnsLabel'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'vcn_id': :'String',
    'vcn_name': :'String',
    'cidr_blocks': :'Array<String>',
    'backup_cidr_blocks': :'Array<String>',
    'dns_label': :'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



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 124

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

  self.class == other.class &&
    vcn_id == other.vcn_id &&
    vcn_name == other.vcn_name &&
    cidr_blocks == other.cidr_blocks &&
    backup_cidr_blocks == other.backup_cidr_blocks &&
    dns_label == other.dns_label
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 158

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


138
139
140
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 147

def hash
  [vcn_id, vcn_name, cidr_blocks, backup_cidr_blocks, dns_label].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 191

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



185
186
187
 
# File 'lib/oci/multicloud/models/oci_vcn.rb', line 185

def to_s
  to_hash.to_s
end