Class: OCI::Waas::Models::AddHttpResponseHeaderAction

Inherits:
HeaderManipulationAction show all
Defined in:
lib/oci/waas/models/add_http_response_header_action.rb

Overview

An object that represents the action of replacing or adding a header field. All prior occurrences of the header with the given name are removed and then the header field with specified value is added.

Constant Summary

Constants inherited from HeaderManipulationAction

HeaderManipulationAction::ACTION_ENUM

Instance Attribute Summary collapse

Attributes inherited from HeaderManipulationAction

#action

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HeaderManipulationAction

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AddHttpResponseHeaderAction

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 57

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 field name that conforms to RFC 7230.

Example: ‘example_header_name`

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 18

def header
  @header
end

#value ⇒ String

[Required] A header field value that conforms to RFC 7230.

Example: ‘example_value`

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 25

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 28

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.



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 39

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



79
80
81
82
83
84
85
86
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 79

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 111

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


91
92
93
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 91

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



100
101
102
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 100

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



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 144

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



138
139
140
 
# File 'lib/oci/waas/models/add_http_response_header_action.rb', line 138

def to_s
  to_hash.to_s
end