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

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



76
77
78
79
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
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
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 76

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}

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

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

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

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

  unless attributes[:'isPrivate'].nil?
    self.is_private = attributes[:'isPrivate']
  else
    self.is_private = false
  end

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

  unless attributes[:'is_private'].nil?
    self.is_private = attributes[:'is_private']
  else
    self.is_private = false
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

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

Returns:



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

def backend_sets
  @backend_sets
end

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

Returns:



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

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) 


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

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: ‘My load balancer`

Returns:

  • (String) 


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

def display_name
  @display_name
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: ‘false`

Returns:

  • (BOOLEAN) 


43
44
45
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 43

def is_private
  @is_private
end

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

Returns:



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

def listeners
  @listeners
end

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

Returns:



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

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) 


58
59
60
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 58

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


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

def subnet_ids
  @subnet_ids
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 168

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 197

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 184

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 190

def hash
  [backend_sets, certificates, compartment_id, display_name, 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



222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 222

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



216
217
218
 
# File 'lib/oci/load_balancer/models/create_load_balancer_details.rb', line 216

def to_s
  to_hash.to_s
end