Class: OCI::Waa::Models::ResponseCachingPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waa/models/response_caching_policy.rb

Overview

An object that specifies an HTTP response caching policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseCachingPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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.is_response_header_based_caching_enabled = attributes[:'isResponseHeaderBasedCachingEnabled'] unless attributes[:'isResponseHeaderBasedCachingEnabled'].nil?
  self.is_response_header_based_caching_enabled = false if is_response_header_based_caching_enabled.nil? && !attributes.key?(:'isResponseHeaderBasedCachingEnabled') # rubocop:disable Style/StringLiterals

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

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

Instance Attribute Details

#is_response_header_based_caching_enabled ⇒ BOOLEAN

When false, responses will not be cached by the backend based on response headers.

When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.

The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.

If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".

If the header includes the "Set-Cookie" field, such a response will not be cached.

If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.

Returns:

  • (BOOLEAN) 


31
32
33
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 31

def is_response_header_based_caching_enabled
  @is_response_header_based_caching_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_response_header_based_caching_enabled': :'isResponseHeaderBasedCachingEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 43

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



80
81
82
83
84
85
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 80

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

  self.class == other.class &&
    is_response_header_based_caching_enabled == other.is_response_header_based_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



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

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


90
91
92
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 90

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



99
100
101
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 99

def hash
  [is_response_header_based_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



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 143

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



137
138
139
 
# File 'lib/oci/waa/models/response_caching_policy.rb', line 137

def to_s
  to_hash.to_s
end