Class: OCI::LoadBalancer::Models::AddHttpResponseHeaderRule

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

Overview

An object that represents the action of adding a header to a response. This rule applies only to HTTP listeners.

NOTES:

  • If a matching header already exists in the response, 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.

Constant Summary

Constants inherited from Rule

Rule::ACTION_ENUM

Instance Attribute Summary collapse

Attributes inherited from Rule

#action

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AddHttpResponseHeaderRule

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

  • :value (String) —

    The value to assign to the #value property



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 70

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

  attributes['action'] = 'ADD_HTTP_RESPONSE_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

Instance Attribute Details

#header ⇒ String

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

Example: example_header_name

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 28

def header
  @header
end

#value ⇒ 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

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 38

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 41

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

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 52

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



92
93
94
95
96
97
98
99
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 92

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

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 124

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


104
105
106
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 113

def hash
  [action, header, value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 157

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



151
152
153
 
# File 'lib/oci/load_balancer/models/add_http_response_header_rule.rb', line 151

def to_s
  to_hash.to_s
end