Class: OCI::LoadBalancer::Models::ExtendHttpResponseHeaderValueRule

Inherits:
LoadBalancer::Models::Rule
  • Object
show all
Defined in:
lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb

Overview

An object that represents the action of modifying a response header value. This rule applies only to HTTP or HTTP2 listeners.

This rule adds a prefix, a suffix, or both to the header value.

NOTES:

  • This rule requires a value for a prefix, suffix, or both.

  • The system does not support this rule for headers with multiple values.

  • 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. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtendHttpResponseHeaderValueRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :header (String) —

    The value to assign to the #header property

  • :prefix (String) —

    The value to assign to the #prefix property

  • :suffix (String) —

    The value to assign to the #suffix property



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

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

  attributes['action'] = 'EXTEND_HTTP_RESPONSE_HEADER_VALUE'

  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.prefix = attributes[:'prefix'] if attributes[:'prefix']

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

Instance Attribute Details

#header ⇒ String

[Required] A header name that conforms to RFC 7230.

Example: ‘example_header_name`

Returns:

  • (String) 


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

def header
  @header
end

#prefix ⇒ String

A string to prepend to the header value. The resulting header value must still conform to RFC 7230.

Example: ‘example_prefix_value`

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 36

def prefix
  @prefix
end

#suffix ⇒ String

A string to append to the header value. The resulting header value must still conform to RFC 7230.

Example: ‘example_suffix_value`

Returns:

  • (String) 


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

def suffix
  @suffix
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action': :'action',
    'header': :'header',
    'prefix': :'prefix',
    'suffix': :'suffix'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'action': :'String',
    'header': :'String',
    'prefix': :'String',
    'suffix': :'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



102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 102

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

  self.class == other.class &&
    action == other.action &&
    header == other.header &&
    prefix == other.prefix &&
    suffix == other.suffix
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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 135

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


115
116
117
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 124

def hash
  [action, header, prefix, suffix].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 168

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



162
163
164
 
# File 'lib/oci/load_balancer/models/extend_http_response_header_value_rule.rb', line 162

def to_s
  to_hash.to_s
end