class OCI::LoadBalancer::Models::PathRoute

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.

Attributes

backend_set_name[RW]

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

Example: `example_backend_set`

@return [String]

path[RW]

[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`

@return [String]

path_match_type[RW]

[Required] The type of matching to apply to incoming URIs. @return [OCI::LoadBalancer::Models::PathMatchType]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/load_balancer/models/path_route.rb, line 38
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'path': :'path',
    'path_match_type': :'pathMatchType',
    'backend_set_name': :'backendSetName'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :path The value to assign to the {#path} property @option attributes [OCI::LoadBalancer::Models::PathMatchType] :path_match_type The value to assign to the {#path_match_type} property @option attributes [String] :backend_set_name The value to assign to the {#backend_set_name} property

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

  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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/load_balancer/models/path_route.rb, line 49
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'path': :'String',
    'path_match_type': :'OCI::LoadBalancer::Models::PathMatchType',
    'backend_set_name': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/path_route.rb, line 96
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    path == other.path &&
    path_match_type == other.path_match_type &&
    backend_set_name == other.backend_set_name
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/load_balancer/models/path_route.rb, line 128
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/path_route.rb, line 108
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/load_balancer/models/path_route.rb, line 117
def hash
  [path, path_match_type, backend_set_name].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/load_balancer/models/path_route.rb, line 161
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/load_balancer/models/path_route.rb, line 155
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/load_balancer/models/path_route.rb, line 178
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end