Class: OCI::Waf::Models::DynamicHttpResponseBody

Inherits:
HttpResponseBody show all
Defined in:
lib/oci/waf/models/dynamic_http_response_body.rb

Overview

Allows returning dynamically generated HTTP response body based on the provided template. The template allows variable interpolation by specifying variable name between the '$and '' delimiters. Escape sequences using '' are supported to allow usage of '\' and '$in the template to return '' and '${' in final response.

The following variables are supported:

  • http.request.id - the HTTP request ID. For example: "d5fa953f75ef417e4c8008ef9336d779".

Example: { "type": "DYNAMIC", "template": "{\ \“code\”: 403,\ \“message\”:\“Unauthorised\”,\ \“incidentId\”: \“${http.request.id\”\ }" }

Example with escape sequence: { "type": "DYNAMIC", "template": "\$as plain text" }

Constant Summary

Constants inherited from HttpResponseBody

HttpResponseBody::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from HttpResponseBody

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HttpResponseBody

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DynamicHttpResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :template (String) —

    The value to assign to the #template property



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 66

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

  attributes['type'] = 'DYNAMIC'

  super(attributes)

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

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

Instance Attribute Details

#template ⇒ String

[Required] Dynamic response body

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 37

def template
  @template
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'template': :'template'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 50

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



86
87
88
89
90
91
92
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 86

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

  self.class == other.class &&
    type == other.type &&
    template == other.template
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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 117

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


97
98
99
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



106
107
108
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 106

def hash
  [type, template].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 150

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



144
145
146
 
# File 'lib/oci/waf/models/dynamic_http_response_body.rb', line 144

def to_s
  to_hash.to_s
end