Class: OracleBMC::LoadBalancer::Models::CreateLoadBalancerDetails

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

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 62

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
  
  if attributes[:'certificates']
    self.certificates = attributes[:'certificates']
  end
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'isPrivate']
    self.is_private = attributes[:'isPrivate']
  else
    self.is_private = false
  end
  
  if attributes[:'listeners']
    self.listeners = attributes[:'listeners']
  end
  
  if attributes[:'shapeName']
    self.shape_name = attributes[:'shapeName']
  end
  
  if attributes[:'subnetIds']
    self.subnet_ids = attributes[:'subnetIds']
  end
  
end

Instance Attribute Details

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

Returns:



8
9
10
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 8

def backend_sets
  @backend_sets
end

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

Returns:



11
12
13
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 11

def certificates
  @certificates
end

#compartment_id ⇒ String

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) 


15
16
17
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 15

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. It does not have to be unique, and it is changeable.

Example: ‘My load balancer`

Returns:

  • (String) 


22
23
24
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 22

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 (stand-by) 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) 


41
42
43
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 41

def is_private
  @is_private
end

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

Returns:



44
45
46
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 44

def listeners
  @listeners
end

#shape_name ⇒ String

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) 


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

def shape_name
  @shape_name
end

#subnet_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


57
58
59
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 57

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



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 107

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



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

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


122
123
124
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 122

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 128

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



160
161
162
163
164
165
166
167
168
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 160

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



154
155
156
 
# File 'lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb', line 154

def to_s
  to_hash.to_s
end