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

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoadBalancer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 87

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[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'ipAddresses']
    self.ip_addresses = attributes[:'ipAddresses']
  end

  if attributes[:'isPrivate']
    self.is_private = attributes[:'isPrivate']
  end

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

end

Instance Attribute Details

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

Returns:



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

def backend_sets
  @backend_sets
end

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

Returns:



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

def certificates
  @certificates
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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) 


30
31
32
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 30

def display_name
  @display_name
end

#id ⇒ String

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

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 34

def id
  @id
end

#ip_addresses ⇒ Array<OCI::LoadBalancer::Models::IpAddress>

An array of IP addresses.

Returns:



39
40
41
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 39

def ip_addresses
  @ip_addresses
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).

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 56

def is_private
  @is_private
end

#lifecycle_state ⇒ String

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

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

Returns:



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

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) 


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

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


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

def subnet_ids
  @subnet_ids
end

#time_created ⇒ DateTime

The date and time the load balancer was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 155

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 &&
      id == other_object.id &&
      ip_addresses == other_object.ip_addresses &&
      is_private == other_object.is_private &&
      lifecycle_state == other_object.lifecycle_state &&
      listeners == other_object.listeners &&
      shape_name == other_object.shape_name &&
      subnet_ids == other_object.subnet_ids &&
      time_created == other_object.time_created
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 187

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


174
175
176
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 174

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 180

def hash
  [backend_sets, certificates, compartment_id, display_name, id, ip_addresses, is_private, lifecycle_state, listeners, shape_name, subnet_ids, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 212

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



206
207
208
 
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 206

def to_s
  to_hash.to_s
end