Class: OCI::LoadBalancer::Models::PathMatchCondition

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

Overview

The path string and match condition to apply when evaluating an incoming URI for redirection.

Constant Summary collapse

OPERATOR_ENUM =
[
  OPERATOR_EXACT_MATCH = 'EXACT_MATCH'.freeze,
  OPERATOR_FORCE_LONGEST_PREFIX_MATCH = 'FORCE_LONGEST_PREFIX_MATCH'.freeze,
  OPERATOR_PREFIX_MATCH = 'PREFIX_MATCH'.freeze,
  OPERATOR_SUFFIX_MATCH = 'SUFFIX_MATCH'.freeze,
  OPERATOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from RuleCondition

RuleCondition::ATTRIBUTE_NAME_ENUM

Instance Attribute Summary collapse

Attributes inherited from RuleCondition

#attribute_name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RuleCondition

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PathMatchCondition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :attribute_value (String)

    The value to assign to the #attribute_value property

  • :operator (String)

    The value to assign to the #operator property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['attributeName'] = 'PATH'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.attribute_value = attributes[:'attributeValue'] if attributes[:'attributeValue']

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

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

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

Instance Attribute Details

#attribute_valueString

[Required] The path string that the redirection rule applies to.

Example: /example

Returns:

  • (String)


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

def attribute_value
  @attribute_value
end

#operatorString

[Required] A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

  • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.

  • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.

  • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.

  • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.

Returns:

  • (String)


43
44
45
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 43

def operator
  @operator
end

Class Method Details

.attribute_mapObject

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



46
47
48
49
50
51
52
53
54
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'attribute_name': :'attributeName',
    'attribute_value': :'attributeValue',
    'operator': :'operator'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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



114
115
116
117
118
119
120
121
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 114

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

  self.class == other.class &&
    attribute_name == other.attribute_name &&
    attribute_value == other.attribute_value &&
    operator == other.operator
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 146

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


126
127
128
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 126

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



135
136
137
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 135

def hash
  [attribute_name, attribute_value, operator].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



173
174
175
# File 'lib/oci/load_balancer/models/path_match_condition.rb', line 173

def to_s
  to_hash.to_s
end