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

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

Overview

A hostname resource associated with a load balancer for use by one or more listeners.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Hostname

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :hostname (String) —

    The value to assign to the #hostname property



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 56

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

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

Instance Attribute Details

#hostname ⇒ String

[Required] A virtual hostname. For more information about virtual hostname string construction, see [Managing Request Routing](docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).

Example: ‘app.example.com`

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 26

def hostname
  @hostname
end

#name ⇒ String

[Required] A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information.

Example: ‘example_hostname_001`

Returns:

  • (String) 


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

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'hostname': :'hostname'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'hostname': :'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



74
75
76
77
78
79
80
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 74

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

  self.class == other.class &&
    name == other.name &&
    hostname == other.hostname
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



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

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


85
86
87
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 85

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [name, hostname].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 138

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



132
133
134
 
# File 'lib/oci/load_balancer/models/hostname.rb', line 132

def to_s
  to_hash.to_s
end