Class: OCI::LoadBalancer::Models::CreateLoadBalancerDetails

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

Overview

The configuration details for creating a load balancer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLoadBalancerDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 120

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

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

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

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

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

  self.is_private = attributes[:'isPrivate'] unless attributes[:'isPrivate'].nil?
  self.is_private = false if is_private.nil? && !attributes.key?(:'isPrivate') # rubocop:disable Style/StringLiterals

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

  self.is_private = attributes[:'is_private'] unless attributes[:'is_private'].nil?
  self.is_private = false if is_private.nil? && !attributes.key?(:'isPrivate') && !attributes.key?(:'is_private') # rubocop:disable Style/StringLiterals

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

  self.path_route_sets = attributes[:'pathRouteSets'] if attributes[:'pathRouteSets']

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

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

  self.shape_name = attributes[:'shapeName'] if attributes[:'shapeName']

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

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

  self.subnet_ids = attributes[:'subnetIds'] if attributes[:'subnetIds']

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

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

Instance Attribute Details

#backend_sets ⇒ Hash<String, OCI::LoadBalancer::Models::BackendSetDetails>

Returns:



10
11
12
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 10

def backend_sets
  @backend_sets
end

#certificates ⇒ Hash<String, OCI::LoadBalancer::Models::CertificateDetails>

Returns:



13
14
15
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 13

def certificates
  @certificates
end

#compartment_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the load balancer.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 17

def compartment_id
  @compartment_id
end

#display_name ⇒ String

[Required] A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: ‘example_load_balancer`

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 25

def display_name
  @display_name
end

#hostnames ⇒ Hash<String, OCI::LoadBalancer::Models::HostnameDetails>

Returns:



28
29
30
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 28

def hostnames
  @hostnames
end

#is_private ⇒ BOOLEAN

Whether the load balancer has a VCN-local (private) IP address.

If "true", the service assigns a private IP address to the load balancer. The load balancer requires only one subnet to host both the primary and secondary load balancers. The private IP address is local to the subnet. The load balancer is accessible only from within the VCN that contains the associated subnet, or as further restricted by your security list rules. The load balancer can route traffic to any backend server that is reachable from the VCN.

For a private load balancer, both the primary and secondary load balancer hosts are within the same Availability Domain.

If "false", the service assigns a public IP address to the load balancer. A load balancer with a public IP address requires two subnets, each in a different Availability Domain. One subnet hosts the primary load balancer and the other hosts the secondary (standby) load balancer. A public load balancer is accessible from the internet, depending on your VCN’s [security list rules](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm).

Example: ‘true`

Returns:

  • (BOOLEAN) 


47
48
49
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 47

def is_private
  @is_private
end

#listeners ⇒ Hash<String, OCI::LoadBalancer::Models::ListenerDetails>

Returns:



50
51
52
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 50

def listeners
  @listeners
end

#path_route_sets ⇒ Hash<String, OCI::LoadBalancer::Models::PathRouteSetDetails>

Returns:



53
54
55
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 53

def path_route_sets
  @path_route_sets
end

#shape_name ⇒ String

[Required] A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the list_shapes operation.

Example: ‘100Mbps`

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 62

def shape_name
  @shape_name
end

#subnet_ids ⇒ Array<String>

[Required] An array of subnet [OCIDs](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).

Returns:

  • (Array<String>) 


66
67
68
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 66

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'backend_sets': :'backendSets',
    'certificates': :'certificates',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'hostnames': :'hostnames',
    'is_private': :'isPrivate',
    'listeners': :'listeners',
    'path_route_sets': :'pathRouteSets',
    'shape_name': :'shapeName',
    'subnet_ids': :'subnetIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 87

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'backend_sets': :'Hash<String, OCI::LoadBalancer::Models::BackendSetDetails>',
    'certificates': :'Hash<String, OCI::LoadBalancer::Models::CertificateDetails>',
    'compartment_id': :'String',
    'display_name': :'String',
    'hostnames': :'Hash<String, OCI::LoadBalancer::Models::HostnameDetails>',
    'is_private': :'BOOLEAN',
    'listeners': :'Hash<String, OCI::LoadBalancer::Models::ListenerDetails>',
    'path_route_sets': :'Hash<String, OCI::LoadBalancer::Models::PathRouteSetDetails>',
    'shape_name': :'String',
    'subnet_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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 184

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    backend_sets == other.backend_sets &&
    certificates == other.certificates &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    hostnames == other.hostnames &&
    is_private == other.is_private &&
    listeners == other.listeners &&
    path_route_sets == other.path_route_sets &&
    shape_name == other.shape_name &&
    subnet_ids == other.subnet_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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 222

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


202
203
204
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 211

def hash
  [backend_sets, certificates, compartment_id, display_name, hostnames, is_private, listeners, path_route_sets, shape_name, subnet_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 254

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



248
249
250
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 248

def to_s
  to_hash.to_s
end