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

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

Overview

A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set.

Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PathRoute

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 67

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

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

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

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

  self.path_match_type = attributes[:'pathMatchType'] if attributes[:'pathMatchType']

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

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

Instance Attribute Details

#backend_set_name ⇒ String

[Required] The name of the target backend set for requests where the incoming URI matches the specified path.

Example: ‘example_backend_set`

Returns:

  • (String) 


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

def backend_set_name
  @backend_set_name
end

#path ⇒ String

[Required] The path string to match against the incoming URI path.

  • Path strings are case-insensitive.

  • Asterisk (*) wildcards are not supported.

  • Regular expressions are not supported.

Example: ‘/example/video/123`

Returns:

  • (String) 


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

def path
  @path
end

#path_match_type ⇒ OCI::LoadBalancer::Models::PathMatchType

[Required] The type of matching to apply to incoming URIs.

Returns:



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

def path_match_type
  @path_match_type
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'backend_set_name': :'backendSetName',
    'path': :'path',
    'path_match_type': :'pathMatchType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'backend_set_name': :'String',
    'path': :'String',
    'path_match_type': :'OCI::LoadBalancer::Models::PathMatchType'
    # 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



95
96
97
98
99
100
101
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 95

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    backend_set_name == other.backend_set_name &&
    path == other.path &&
    path_match_type == other.path_match_type
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 126

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


106
107
108
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 106

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 115

def hash
  [backend_set_name, path, path_match_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 158

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



152
153
154
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 152

def to_s
  to_hash.to_s
end