Class: OCI::Apigateway::Models::ResponseCacheLookupPolicy

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

Overview

Base policy for Response Cache lookup.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

SimpleLookupPolicy

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_SIMPLE_LOOKUP_POLICY = 'SIMPLE_LOOKUP_POLICY'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseCacheLookupPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :is_private_caching_enabled (BOOLEAN) —

    The value to assign to the #is_private_caching_enabled property



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 84

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.type = attributes[:'type'] if attributes[:'type']

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

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

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

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

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

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

Instance Attribute Details

#is_enabled ⇒ BOOLEAN

Whether this policy is currently enabled.

Returns:

  • (BOOLEAN) 


26
27
28
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 26

def is_enabled
  @is_enabled
end

#is_private_caching_enabled ⇒ BOOLEAN

Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.

When false, any request with an Authorization header will not be stored in the Response Cache.

If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.

Returns:

  • (BOOLEAN) 


36
37
38
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 36

def is_private_caching_enabled
  @is_private_caching_enabled
end

#type ⇒ String

[Required] Type of the Response Cache Store Policy.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 21

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'is_enabled': :'isEnabled',
    'is_private_caching_enabled': :'isPrivateCachingEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



65
66
67
68
69
70
71
72
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 65

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Apigateway::Models::SimpleLookupPolicy' if type == 'SIMPLE_LOOKUP_POLICY'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Apigateway::Models::ResponseCacheLookupPolicy'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



129
130
131
132
133
134
135
136
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 129

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

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 161

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


141
142
143
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 150

def hash
  [type, is_enabled, is_private_caching_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 194

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



188
189
190
 
# File 'lib/oci/apigateway/models/response_cache_lookup_policy.rb', line 188

def to_s
  to_hash.to_s
end