Class: OCI::LoadBalancer::Models::UpdateNetworkSecurityGroupsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/load_balancer/models/update_network_security_groups_details.rb

Overview

An object representing an updated list of network security groups (NSGs) that overwrites the existing list of NSGs. * If the load balancer has no NSGs configured, it uses the NSGs in this list. * If the load balancer has a list of NSGs configured, this list replaces the existing list. * If the load balancer has a list of NSGs configured and this list is empty, the operation removes all of the load balancer's NSG associations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateNetworkSecurityGroupsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 53

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

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

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

Instance Attribute Details

#network_security_group_ids ⇒ Array<String>

An array of NSG OCIDs associated with the load balancer.

During the load balancer's creation, the service adds the new load balancer to the specified NSGs.

The benefits of associating the load balancer with NSGs include:

  • NSGs define network security rules to govern ingress and egress traffic for the load balancer.

  • The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access.

Returns:

  • (Array<String>) 


26
27
28
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 26

def network_security_group_ids
  @network_security_group_ids
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'network_security_group_ids': :'networkSecurityGroupIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'network_security_group_ids': :'Array<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



73
74
75
76
77
78
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 73

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

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 103

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


83
84
85
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 83

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



92
93
94
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 92

def hash
  [network_security_group_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 136

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



130
131
132
 
# File 'lib/oci/load_balancer/models/update_network_security_groups_details.rb', line 130

def to_s
  to_hash.to_s
end