Class: OCI::Core::Models::UpdateSubnetDetails

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

Overview

UpdateSubnetDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSubnetDetails

Initializes the object

Options Hash (attributes):

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :dhcp_options_id (String) —

    The value to assign to the #dhcp_options_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :route_table_id (String) —

    The value to assign to the #route_table_id property

  • :security_list_ids (Array<String>) —

    The value to assign to the #security_list_ids property

  • :cidr_block (String) —

    The value to assign to the #cidr_block property



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 106

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

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

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

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

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

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

  self.security_list_ids = attributes[:'securityListIds'] if attributes[:'securityListIds']

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

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

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

Instance Attribute Details

#cidr_block ⇒ String

The CIDR IP address block of the Subnet. The CIDR must maintain the following rules -

  1. The CIDR block is valid and correctly formatted.

  2. The new range is within one of the parent VCN ranges.

  3. The old and new CIDR ranges both use the same base address. Example: 10.0.0.0/25 and 10.0.0.0/24.

  4. The new CIDR range contains all previously allocated private IP addresses in the old CIDR range.

  5. No previously allocated IP address overlaps the broadcast address (the last IP of a subnet CIDR range) of the new CIDR range.

Example: 172.16.0.0/16



61
62
63
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 61

def cidr_block
  @cidr_block
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

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

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



16
17
18
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 16

def defined_tags
  @defined_tags
end

#dhcp_options_id ⇒ String

The OCID of the set of DHCP options the subnet will use.



21
22
23
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 21

def dhcp_options_id
  @dhcp_options_id
end

#display_name ⇒ String

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



27
28
29
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 27

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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

Example: ‘"Finance"`



35
36
37
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 35

def freeform_tags
  @freeform_tags
end

#route_table_id ⇒ String

The OCID of the route table the subnet will use.



40
41
42
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 40

def route_table_id
  @route_table_id
end

#security_list_ids ⇒ Array<String>

The OCIDs of the security list or lists the subnet will use. This replaces the entire current set of security lists. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet.



48
49
50
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 48

def security_list_ids
  @security_list_ids
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'definedTags',
    'dhcp_options_id': :'dhcpOptionsId',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'route_table_id': :'routeTableId',
    'security_list_ids': :'securityListIds',
    'cidr_block': :'cidrBlock'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'dhcp_options_id': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'route_table_id': :'String',
    'security_list_ids': :'Array<String>',
    'cidr_block': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 162

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

  self.class == other.class &&
    defined_tags == other.defined_tags &&
    dhcp_options_id == other.dhcp_options_id &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    route_table_id == other.route_table_id &&
    security_list_ids == other.security_list_ids &&
    cidr_block == other.cidr_block
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 198

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

See Also:

  • `==` method


178
179
180
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 178

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



187
188
189
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 187

def hash
  [defined_tags, dhcp_options_id, display_name, freeform_tags, route_table_id, security_list_ids, cidr_block].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 231

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



225
226
227
 
# File 'lib/oci/core/models/update_subnet_details.rb', line 225

def to_s
  to_hash.to_s
end