Class: OCI::Apigateway::Models::StaticPublicKey

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

Overview

A static public key which is used to verify the JWT signature. 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

JsonWebKey, PemEncodedPublicKey

Constant Summary collapse

FORMAT_ENUM =
[
  FORMAT_JSON_WEB_KEY = 'JSON_WEB_KEY'.freeze,
  FORMAT_PEM = 'PEM'.freeze,
  FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StaticPublicKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :kid (String)

    The value to assign to the #kid property

  • :format (String)

    The value to assign to the #format property



72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/apigateway/models/static_public_key.rb', line 72

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

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

Instance Attribute Details

#formatString

[Required] The format of the public key.

Returns:

  • (String)


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

def format
  @format
end

#kidString

[Required] A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Returns:

  • (String)


22
23
24
# File 'lib/oci/apigateway/models/static_public_key.rb', line 22

def kid
  @kid
end

Class Method Details

.attribute_mapObject

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



29
30
31
32
33
34
35
36
# File 'lib/oci/apigateway/models/static_public_key.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kid': :'kid',
    'format': :'format'
    # 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.



53
54
55
56
57
58
59
60
61
# File 'lib/oci/apigateway/models/static_public_key.rb', line 53

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

  return 'OCI::Apigateway::Models::JsonWebKey' if type == 'JSON_WEB_KEY'
  return 'OCI::Apigateway::Models::PemEncodedPublicKey' if type == 'PEM'

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

.swagger_typesObject

Attribute type mapping.



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

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



103
104
105
106
107
108
109
# File 'lib/oci/apigateway/models/static_public_key.rb', line 103

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

  self.class == other.class &&
    kid == other.kid &&
    format == other.format
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



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

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


114
115
116
# File 'lib/oci/apigateway/models/static_public_key.rb', line 114

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



123
124
125
# File 'lib/oci/apigateway/models/static_public_key.rb', line 123

def hash
  [kid, format].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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



161
162
163
# File 'lib/oci/apigateway/models/static_public_key.rb', line 161

def to_s
  to_hash.to_s
end