Class: Kubernetes::V1TokenReviewStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1_token_review_status.rb

Overview

TokenReviewStatus is the result of the token authentication request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1TokenReviewStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 52

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

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

  if attributes.key?(:audiences) && (value = attributes[:audiences]).is_a?(Array)
    self.audiences = value
  end

  self.authenticated = attributes[:authenticated] if attributes.key?(:authenticated)

  self.error = attributes[:error] if attributes.key?(:error)

  self.user = attributes[:user] if attributes.key?(:user)
end

Instance Attribute Details

#audiencesObject

Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token’s audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.



19
20
21
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 19

def audiences
  @audiences
end

#authenticatedObject

Authenticated indicates that the token was associated with a known user.



22
23
24
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 22

def authenticated
  @authenticated
end

#errorObject

Error indicates that the token couldn’t be checked



25
26
27
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 25

def error
  @error
end

#userObject

User is the UserInfo associated with the provided token.



28
29
30
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 28

def user
  @user
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 31

def self.attribute_map
  {
    audiences: :audiences,
    authenticated: :authenticated,
    error: :error,
    user: :user
  }
end

.swagger_typesObject

Attribute type mapping.



41
42
43
44
45
46
47
48
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 41

def self.swagger_types
  {
    audiences: :'Array<String>',
    authenticated: :BOOLEAN,
    error: :String,
    user: :V1UserInfo
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



83
84
85
86
87
88
89
90
91
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 83

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

  self.class == other.class &&
    audiences == other.audiences &&
    authenticated == other.authenticated &&
    error == other.error &&
    user == other.user
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 132

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Kubernetes.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 199

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 108

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


95
96
97
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 95

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



101
102
103
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 101

def hash
  [audiences, authenticated, error, user].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



71
72
73
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 71

def list_invalid_properties
  []
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



178
179
180
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 178

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 184

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



172
173
174
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 172

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



77
78
79
# File 'lib/kubernetes/models/v1_token_review_status.rb', line 77

def valid?
  true
end