Class: OCI::LoadBalancer::Models::HttpHeaderRule

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

Overview

An object that represents the advance http header options that allow the setting of http header size and allow/disallow invalid characters in the http headers. For example httpLargeHeaderSizeInKB=32, the http header could have 4 buffers of 32KBs each This rule applies only to HTTP listeners. No more than one HttpHeaderRule object can be present in a given listener.

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 = {}) ⇒ HttpHeaderRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 61

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

  attributes['action'] = 'HTTP_HEADER'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.are_invalid_characters_allowed = attributes[:'areInvalidCharactersAllowed'] unless attributes[:'areInvalidCharactersAllowed'].nil?

  raise 'You cannot provide both :areInvalidCharactersAllowed and :are_invalid_characters_allowed' if attributes.key?(:'areInvalidCharactersAllowed') && attributes.key?(:'are_invalid_characters_allowed')

  self.are_invalid_characters_allowed = attributes[:'are_invalid_characters_allowed'] unless attributes[:'are_invalid_characters_allowed'].nil?

  self.http_large_header_size_in_kb = attributes[:'httpLargeHeaderSizeInKB'] if attributes[:'httpLargeHeaderSizeInKB']

  raise 'You cannot provide both :httpLargeHeaderSizeInKB and :http_large_header_size_in_kb' if attributes.key?(:'httpLargeHeaderSizeInKB') && attributes.key?(:'http_large_header_size_in_kb')

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

Instance Attribute Details

#are_invalid_characters_allowedBOOLEAN

Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

Returns:

  • (BOOLEAN)


22
23
24
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 22

def are_invalid_characters_allowed
  @are_invalid_characters_allowed
end

#http_large_header_size_in_kbInteger

The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

Returns:

  • (Integer)


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

def http_large_header_size_in_kb
  @http_large_header_size_in_kb
end

Class Method Details

.attribute_mapObject

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



32
33
34
35
36
37
38
39
40
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action': :'action',
    'are_invalid_characters_allowed': :'areInvalidCharactersAllowed',
    'http_large_header_size_in_kb': :'httpLargeHeaderSizeInKB'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



43
44
45
46
47
48
49
50
51
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 43

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



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

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

  self.class == other.class &&
    action == other.action &&
    are_invalid_characters_allowed == other.are_invalid_characters_allowed &&
    http_large_header_size_in_kb == other.http_large_header_size_in_kb
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



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

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


103
104
105
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 103

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



112
113
114
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 112

def hash
  [action, are_invalid_characters_allowed, http_large_header_size_in_kb].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



150
151
152
# File 'lib/oci/load_balancer/models/http_header_rule.rb', line 150

def to_s
  to_hash.to_s
end