Class: OCI::Apigateway::Models::JsonWebTokenClaim

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

Overview

An individual JWT claim.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JsonWebTokenClaim

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :values (Array<String>) —

    The value to assign to the #values property

  • :is_required (BOOLEAN) —

    The value to assign to the #is_required property



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 60

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

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

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

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

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

Instance Attribute Details

#is_required ⇒ BOOLEAN

Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.

Returns:

  • (BOOLEAN) 


27
28
29
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 27

def is_required
  @is_required
end

#key ⇒ String

[Required] Name of the claim.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 13

def key
  @key
end

#values ⇒ Array<String>

The list of acceptable values for a given claim. If this value is "null" or empty and "isRequired" set to "true", then the presence of this claim in the JWT is validated.

Returns:

  • (Array<String>) 


20
21
22
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 20

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'values': :'values',
    'is_required': :'isRequired'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'values': :'Array<String>',
    'is_required': :'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



86
87
88
89
90
91
92
93
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 86

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

  self.class == other.class &&
    key == other.key &&
    values == other.values &&
    is_required == other.is_required
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



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

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


98
99
100
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 107

def hash
  [key, values, is_required].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 151

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



145
146
147
 
# File 'lib/oci/apigateway/models/json_web_token_claim.rb', line 145

def to_s
  to_hash.to_s
end