class OCI::LoadBalancer::Models::RedirectRule
An object that represents the action of returning a specified response code and a redirect URI. Each RedirectRule
object is configured for a particular listener and a designated path.
The default response code is `302 Found`.
NOTES:
-
This rule applies only to HTTP listeners.
-
You can specify this rule only with the {#rule_condition rule_condition} type `PATH`.
-
A listener can have only one
RedirectRule
object for a given original path. The
{#path_match_condition path_match_condition} `attributeValue` specifies the original path.
Attributes
This attribute is required. @return [Array<OCI::LoadBalancer::Models::RuleCondition>]
@return [OCI::LoadBalancer::Models::RedirectUri]
The HTTP status code to return when the incoming request is redirected.
The status line returned with the code is mapped from the standard HTTP specification. Valid response codes for redirection are:
-
301
-
302
-
303
-
307
-
308
The default value is `302` (Found).
Example: `301`
@return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/load_balancer/models/redirect_rule.rb, line 49 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'action': :'action', 'response_code': :'responseCode', 'conditions': :'conditions', 'redirect_uri': :'redirectUri' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :response_code The value to assign to the {#response_code} property @option attributes [Array<OCI::LoadBalancer::Models::RuleCondition>] :conditions The value to assign to the {#conditions} property @option attributes [OCI::LoadBalancer::Models::RedirectUri] :redirect_uri The value to assign to the {#redirect_uri} property
OCI::LoadBalancer::Models::Rule::new
# File lib/oci/load_balancer/models/redirect_rule.rb, line 81 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['action'] = 'REDIRECT' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.response_code = attributes[:'responseCode'] if attributes[:'responseCode'] self.response_code = 302 if response_code.nil? && !attributes.key?(:'responseCode') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :responseCode and :response_code' if attributes.key?(:'responseCode') && attributes.key?(:'response_code') self.response_code = attributes[:'response_code'] if attributes[:'response_code'] self.response_code = 302 if response_code.nil? && !attributes.key?(:'responseCode') && !attributes.key?(:'response_code') # rubocop:disable Style/StringLiterals self.conditions = attributes[:'conditions'] if attributes[:'conditions'] self.redirect_uri = attributes[:'redirectUri'] if attributes[:'redirectUri'] raise 'You cannot provide both :redirectUri and :redirect_uri' if attributes.key?(:'redirectUri') && attributes.key?(:'redirect_uri') self.redirect_uri = attributes[:'redirect_uri'] if attributes[:'redirect_uri'] end
Attribute type mapping.
# File lib/oci/load_balancer/models/redirect_rule.rb, line 61 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'action': :'String', 'response_code': :'Integer', 'conditions': :'Array<OCI::LoadBalancer::Models::RuleCondition>', 'redirect_uri': :'OCI::LoadBalancer::Models::RedirectUri' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/load_balancer/models/redirect_rule.rb, line 115 def ==(other) return true if equal?(other) self.class == other.class && action == other.action && response_code == other.response_code && conditions == other.conditions && redirect_uri == other.redirect_uri end
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/redirect_rule.rb, line 148 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/load_balancer/models/redirect_rule.rb, line 128 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/load_balancer/models/redirect_rule.rb, line 137 def hash [action, response_code, conditions, redirect_uri].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/load_balancer/models/redirect_rule.rb, line 181 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/load_balancer/models/redirect_rule.rb, line 175 def to_s to_hash.to_s end
Private Instance Methods
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/redirect_rule.rb, line 198 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