class OCI::LoadBalancer::Models::AddHttpRequestHeaderRule
An object that represents the action of adding a header to a request. This rule applies only to HTTP listeners. NOTES:
-
If a matching header already exists in the request, the system removes all of its occurrences, and then adds the new header.
-
The system does not distinquish between underscore and dash characters in headers. That is, it treats
`example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
Attributes
[Required] A header name that conforms to RFC 7230.
Example: `example_header_name`
@return [String]
[Required] A header value that conforms to RFC 7230. With the following exceptions:
-
value cannot contain `$`
-
value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid.
Example: `example_value`
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/load_balancer/models/add_http_request_header_rule.rb, line 38 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'action': :'action', 'header': :'header', 'value': :'value' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :header The value to assign to the {#header} property @option attributes [String] :value The value to assign to the {#value} property
OCI::LoadBalancer::Models::Rule::new
# File lib/oci/load_balancer/models/add_http_request_header_rule.rb, line 67 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['action'] = 'ADD_HTTP_REQUEST_HEADER' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.header = attributes[:'header'] if attributes[:'header'] self.value = attributes[:'value'] if attributes[:'value'] end
Attribute type mapping.
# File lib/oci/load_balancer/models/add_http_request_header_rule.rb, line 49 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'action': :'String', 'header': :'String', 'value': :'String' # 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/add_http_request_header_rule.rb, line 89 def ==(other) return true if equal?(other) self.class == other.class && action == other.action && header == other.header && value == other.value 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/add_http_request_header_rule.rb, line 121 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/add_http_request_header_rule.rb, line 101 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/load_balancer/models/add_http_request_header_rule.rb, line 110 def hash [action, header, value].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/add_http_request_header_rule.rb, line 154 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/add_http_request_header_rule.rb, line 148 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/add_http_request_header_rule.rb, line 171 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