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

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 41

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

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

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

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

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

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

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

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: ‘My_backend_set`

Returns:

  • (String) 


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

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) 


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

def path
  @path
end

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

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

Returns:



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

def path_match_type
  @path_match_type
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



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

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 98

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.public_method("#{key}=").call(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.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



91
92
93
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 91

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



123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 123

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



117
118
119
 
# File 'lib/oci/load_balancer/models/path_route.rb', line 117

def to_s
  to_hash.to_s
end