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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

IP_MODE_ENUM = 
[
  IP_MODE_IPV4 = 'IPV4'.freeze,
  IP_MODE_IPV6 = 'IPV6'.freeze
].freeze

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):



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 174

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.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.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.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.ip_mode = attributes[:'ipMode'] if attributes[:'ipMode']
  self.ip_mode = "IPV4" if ip_mode.nil? && !attributes.key?(:'ipMode') # rubocop:disable Style/StringLiterals

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

  self.ip_mode = attributes[:'ip_mode'] if attributes[:'ip_mode']
  self.ip_mode = "IPV4" if ip_mode.nil? && !attributes.key?(:'ipMode') && !attributes.key?(:'ip_mode') # rubocop:disable Style/StringLiterals

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

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

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

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

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

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

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

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

Instance Attribute Details

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

Returns:



71
72
73
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 71

def backend_sets
  @backend_sets
end

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

Returns:



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

def certificates
  @certificates
end

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the load balancer.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 19

def compartment_id
  @compartment_id
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"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


102
103
104
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 102

def defined_tags
  @defined_tags
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) 


27
28
29
 
# File 'lib/oci/load_balancer/models/create_load_balancer_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"`

Returns:

  • (Hash<String, String>) 


94
95
96
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 94

def freeform_tags
  @freeform_tags
end

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

Returns:



68
69
70
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 68

def hostnames
  @hostnames
end

#ip_mode ⇒ String

Whether the load balancer has an IPv4 or IPv6 IP address.

If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.

If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.

Example: "ipMode":"IPV6"

Returns:

  • (String) 


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

def ip_mode
  @ip_mode
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.

If "false", the service assigns a public IP address to the load balancer.

A public load balancer is accessible from the internet, depending on your VCN’s [security list rules](docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).

Example: true

Returns:

  • (BOOLEAN) 


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

def is_private
  @is_private
end

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

Returns:



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

def listeners
  @listeners
end

#network_security_group_ids ⇒ Array<String>

The array of NSG [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) to be used by this Load Balancer.

Returns:

  • (Array<String>) 


76
77
78
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 76

def network_security_group_ids
  @network_security_group_ids
end

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

Returns:



86
87
88
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 86

def path_route_sets
  @path_route_sets
end

#rule_sets ⇒ Hash<String, OCI::LoadBalancer::Models::RuleSetDetails>

Returns:



105
106
107
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 105

def rule_sets
  @rule_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) 


36
37
38
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 36

def shape_name
  @shape_name
end

#subnet_ids ⇒ Array<String>

[Required] An array of subnet [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).

Returns:

  • (Array<String>) 


80
81
82
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 80

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 108

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'shape_name': :'shapeName',
    'is_private': :'isPrivate',
    'ip_mode': :'ipMode',
    'listeners': :'listeners',
    'hostnames': :'hostnames',
    'backend_sets': :'backendSets',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'subnet_ids': :'subnetIds',
    'certificates': :'certificates',
    'path_route_sets': :'pathRouteSets',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'rule_sets': :'ruleSets'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 131

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 278

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    shape_name == other.shape_name &&
    is_private == other.is_private &&
    ip_mode == other.ip_mode &&
    listeners == other.listeners &&
    hostnames == other.hostnames &&
    backend_sets == other.backend_sets &&
    network_security_group_ids == other.network_security_group_ids &&
    subnet_ids == other.subnet_ids &&
    certificates == other.certificates &&
    path_route_sets == other.path_route_sets &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    rule_sets == other.rule_sets
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 322

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


302
303
304
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 311

def hash
  [compartment_id, display_name, shape_name, is_private, ip_mode, listeners, hostnames, backend_sets, network_security_group_ids, subnet_ids, certificates, path_route_sets, freeform_tags, defined_tags, rule_sets].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 355

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



349
350
351
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 349

def to_s
  to_hash.to_s
end