Class: OCI::Apigateway::Models::BodyValidationRequestPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/body_validation_request_policy.rb

Overview

Validate the payload body of the incoming API requests on a specific route.

Constant Summary collapse

VALIDATION_MODE_ENUM = 
[
  VALIDATION_MODE_ENFORCING = 'ENFORCING'.freeze,
  VALIDATION_MODE_PERMISSIVE = 'PERMISSIVE'.freeze,
  VALIDATION_MODE_DISABLED = 'DISABLED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BodyValidationRequestPolicy

Initializes the object

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 79

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

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

  self.required = attributes[:'required'] unless attributes[:'required'].nil?
  self.required = false if required.nil? && !attributes.key?(:'required') # rubocop:disable Style/StringLiterals

  self.content = attributes[:'content'] if attributes[:'content']

  self.validation_mode = attributes[:'validationMode'] if attributes[:'validationMode']
  self.validation_mode = "ENFORCING" if validation_mode.nil? && !attributes.key?(:'validationMode') # rubocop:disable Style/StringLiterals

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

  self.validation_mode = attributes[:'validation_mode'] if attributes[:'validation_mode']
  self.validation_mode = "ENFORCING" if validation_mode.nil? && !attributes.key?(:'validationMode') && !attributes.key?(:'validation_mode') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#content ⇒ Hash<String, OCI::Apigateway::Models::ContentValidation>

[Required] The content of the request body. The key is a [media type range](tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema

key ::= (
      / (  \"*\" \"/\" \"*\" )
      / ( type \"/\" \"*\" )
      / ( type \"/\" subtype )
      )

For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*



33
34
35
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 33

def content
  @content
end

#required ⇒ BOOLEAN

Determines if the request body is required in the request.



18
19
20
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 18

def required
  @required
end

#validation_mode ⇒ String

Validation behavior mode.

In ENFORCING mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend.

In PERMISSIVE mode, the result of the validation will be exposed as metrics while the request will follow the normal path.

DISABLED type turns the validation off.



46
47
48
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 46

def validation_mode
  @validation_mode
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'required': :'required',
    'content': :'content',
    'validation_mode': :'validationMode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'required': :'BOOLEAN',
    'content': :'Hash<String, OCI::Apigateway::Models::ContentValidation>',
    'validation_mode': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



114
115
116
117
118
119
120
121
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 114

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

  self.class == other.class &&
    required == other.required &&
    content == other.content &&
    validation_mode == other.validation_mode
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 146

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

See Also:

  • `==` method


126
127
128
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



135
136
137
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 135

def hash
  [required, content, validation_mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 179

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



173
174
175
 
# File 'lib/oci/apigateway/models/body_validation_request_policy.rb', line 173

def to_s
  to_hash.to_s
end