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

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

Overview

The listener’s configuration. For more information on backend set configuration, see [Managing Load Balancer Listeners](docs.cloud.oracle.com/Content/Balance/Tasks/managinglisteners.htm).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Listener

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

  self.hostname_names = attributes[:'hostnameNames'] if attributes[:'hostnameNames']

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

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

  self.path_route_set_name = attributes[:'pathRouteSetName'] if attributes[:'pathRouteSetName']

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

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

  self.ssl_configuration = attributes[:'sslConfiguration'] if attributes[:'sslConfiguration']

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

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

  self.connection_configuration = attributes[:'connectionConfiguration'] if attributes[:'connectionConfiguration']

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

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

  self.rule_set_names = attributes[:'ruleSetNames'] if attributes[:'ruleSetNames']

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

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

Instance Attribute Details

#connection_configuration ⇒ OCI::LoadBalancer::Models::ConnectionConfiguration

Returns:



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

def connection_configuration
  @connection_configuration
end

#default_backend_set_name ⇒ String

[Required] The name of the associated backend set.

Example: ‘example_backend_set`

Returns:

  • (String) 


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

def default_backend_set_name
  @default_backend_set_name
end

#hostname_names ⇒ Array<String>

An array of hostname resource names.

Returns:

  • (Array<String>) 


44
45
46
 
# File 'lib/oci/load_balancer/models/listener.rb', line 44

def hostname_names
  @hostname_names
end

#name ⇒ String

[Required] A friendly name for the listener. It must be unique and it cannot be changed.

Example: ‘example_listener`

Returns:

  • (String) 


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

def name
  @name
end

#path_route_set_name ⇒ String

The name of the set of path-based routing rules, PathRouteSet, applied to this listener’s traffic.

Example: ‘example_path_route_set`

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/load_balancer/models/listener.rb', line 52

def path_route_set_name
  @path_route_set_name
end

#port ⇒ Integer

[Required] The communication port for the listener.

Example: ‘80`

Returns:

  • (Integer) 


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

def port
  @port
end

#protocol ⇒ String

[Required] The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the list_protocols operation.

Example: ‘HTTP`

Returns:

  • (String) 


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

def protocol
  @protocol
end

#rule_set_names ⇒ Array<String>

The names of the RuleSet to apply to the listener.

Example: ["example_rule_set"]

Returns:

  • (Array<String>) 


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

def rule_set_names
  @rule_set_names
end

#ssl_configuration ⇒ OCI::LoadBalancer::Models::SSLConfiguration

Returns:



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

def ssl_configuration
  @ssl_configuration
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/load_balancer/models/listener.rb', line 68

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'default_backend_set_name': :'defaultBackendSetName',
    'port': :'port',
    'protocol': :'protocol',
    'hostname_names': :'hostnameNames',
    'path_route_set_name': :'pathRouteSetName',
    'ssl_configuration': :'sslConfiguration',
    'connection_configuration': :'connectionConfiguration',
    'rule_set_names': :'ruleSetNames'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/load_balancer/models/listener.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'default_backend_set_name': :'String',
    'port': :'Integer',
    'protocol': :'String',
    'hostname_names': :'Array<String>',
    'path_route_set_name': :'String',
    'ssl_configuration': :'OCI::LoadBalancer::Models::SSLConfiguration',
    'connection_configuration': :'OCI::LoadBalancer::Models::ConnectionConfiguration',
    'rule_set_names': :'Array<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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/load_balancer/models/listener.rb', line 172

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

  self.class == other.class &&
    name == other.name &&
    default_backend_set_name == other.default_backend_set_name &&
    port == other.port &&
    protocol == other.protocol &&
    hostname_names == other.hostname_names &&
    path_route_set_name == other.path_route_set_name &&
    ssl_configuration == other.ssl_configuration &&
    connection_configuration == other.connection_configuration &&
    rule_set_names == other.rule_set_names
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/load_balancer/models/listener.rb', line 210

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/load_balancer/models/listener.rb', line 199

def hash
  [name, default_backend_set_name, port, protocol, hostname_names, path_route_set_name, ssl_configuration, connection_configuration, rule_set_names].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/load_balancer/models/listener.rb', line 243

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



237
238
239
 
# File 'lib/oci/load_balancer/models/listener.rb', line 237

def to_s
  to_hash.to_s
end