Class: OCI::Apigateway::Models::RemoteJsonWebKeySet

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

Overview

A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.

Constant Summary

Constants inherited from PublicKeySet

PublicKeySet::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from PublicKeySet

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PublicKeySet

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RemoteJsonWebKeySet

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 64

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

  attributes['type'] = 'REMOTE_JWKS'

  super(attributes)

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

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

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

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

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

  self.max_cache_duration_in_hours = attributes[:'maxCacheDurationInHours'] if attributes[:'maxCacheDurationInHours']
  self.max_cache_duration_in_hours = 1 if max_cache_duration_in_hours.nil? && !attributes.key?(:'maxCacheDurationInHours') # rubocop:disable Style/StringLiterals

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

  self.max_cache_duration_in_hours = attributes[:'max_cache_duration_in_hours'] if attributes[:'max_cache_duration_in_hours']
  self.max_cache_duration_in_hours = 1 if max_cache_duration_in_hours.nil? && !attributes.key?(:'maxCacheDurationInHours') && !attributes.key?(:'max_cache_duration_in_hours') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#is_ssl_verify_disabledBOOLEAN

Defines whether or not to uphold SSL verification.

Returns:

  • (BOOLEAN)


23
24
25
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 23

def is_ssl_verify_disabled
  @is_ssl_verify_disabled
end

#max_cache_duration_in_hoursInteger

The duration for which the JWKS should be cached before it is fetched again.

Returns:

  • (Integer)


29
30
31
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 29

def max_cache_duration_in_hours
  @max_cache_duration_in_hours
end

#uriString

[Required] The uri from which to retrieve the key. It must be accessible without authentication.

Returns:

  • (String)


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

def uri
  @uri
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
41
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'uri': :'uri',
    'is_ssl_verify_disabled': :'isSslVerifyDisabled',
    'max_cache_duration_in_hours': :'maxCacheDurationInHours'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 44

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



100
101
102
103
104
105
106
107
108
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 100

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

  self.class == other.class &&
    type == other.type &&
    uri == other.uri &&
    is_ssl_verify_disabled == other.is_ssl_verify_disabled &&
    max_cache_duration_in_hours == other.max_cache_duration_in_hours
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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 133

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


113
114
115
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 113

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



122
123
124
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 122

def hash
  [type, uri, is_ssl_verify_disabled, max_cache_duration_in_hours].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 166

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



160
161
162
# File 'lib/oci/apigateway/models/remote_json_web_key_set.rb', line 160

def to_s
  to_hash.to_s
end