Class: Akeyless::GatewayUpdateK8SAuthConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/gateway_update_k8_s_auth_config.rb

Overview

gatewayUpdateK8SAuth is a command that updates k8s auth config

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayUpdateK8SAuthConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::GatewayUpdateK8SAuthConfig` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::GatewayUpdateK8SAuthConfig`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_idObject

The access ID of the Kubernetes auth method



20
21
22
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 20

def access_id
  @access_id
end

#config_encryption_key_nameObject

Config encryption key



23
24
25
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 23

def config_encryption_key_name
  @config_encryption_key_name
end

#k8s_ca_certObject

The CA Cert (in PEM format) to use to call into the kubernetes API server



26
27
28
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 26

def k8s_ca_cert
  @k8s_ca_cert
end

#k8s_hostObject

The URL of the kubernetes API server



29
30
31
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 29

def k8s_host
  @k8s_host
end

#k8s_issuerObject

The Kubernetes JWT issuer name. If not set, kubernetes/serviceaccount will use as an issuer.



32
33
34
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 32

def k8s_issuer
  @k8s_issuer
end

#nameObject

K8S Auth config name



35
36
37
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 35

def name
  @name
end

#new_nameObject

K8S Auth config new name



38
39
40
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 38

def new_name
  @new_name
end

#signing_keyObject

The private key (in base64 encoded of the PEM format) associated with the public key defined in the Kubernetes auth



41
42
43
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 41

def signing_key
  @signing_key
end

#tokenObject

Authentication token (see /auth and /configure)



44
45
46
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 44

def token
  @token
end

#token_expObject

Time in seconds of expiration of the Akeyless Kube Auth Method token



47
48
49
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 47

def token_exp
  @token_exp
end

#token_reviewer_jwtObject

A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs. If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.



50
51
52
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 50

def token_reviewer_jwt
  @token_reviewer_jwt
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



53
54
55
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 53

def uid_token
  @uid_token
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



74
75
76
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 56

def self.attribute_map
  {
    :'access_id' => :'access-id',
    :'config_encryption_key_name' => :'config-encryption-key-name',
    :'k8s_ca_cert' => :'k8s-ca-cert',
    :'k8s_host' => :'k8s-host',
    :'k8s_issuer' => :'k8s-issuer',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'signing_key' => :'signing-key',
    :'token' => :'token',
    :'token_exp' => :'token-exp',
    :'token_reviewer_jwt' => :'token-reviewer-jwt',
    :'uid_token' => :'uid-token'
  }
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



238
239
240
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 238

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



97
98
99
100
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 97

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 79

def self.openapi_types
  {
    :'access_id' => :'String',
    :'config_encryption_key_name' => :'String',
    :'k8s_ca_cert' => :'String',
    :'k8s_host' => :'String',
    :'k8s_issuer' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'signing_key' => :'String',
    :'token' => :'String',
    :'token_exp' => :'Integer',
    :'token_reviewer_jwt' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_id == o.access_id &&
      config_encryption_key_name == o.config_encryption_key_name &&
      k8s_ca_cert == o.k8s_ca_cert &&
      k8s_host == o.k8s_host &&
      k8s_issuer == o.k8s_issuer &&
      name == o.name &&
      new_name == o.new_name &&
      signing_key == o.signing_key &&
      token == o.token &&
      token_exp == o.token_exp &&
      token_reviewer_jwt == o.token_reviewer_jwt &&
      uid_token == o.uid_token
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 269

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 340

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 245

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 225

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



231
232
233
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 231

def hash
  [access_id, config_encryption_key_name, k8s_ca_cert, k8s_host, k8s_issuer, name, new_name, signing_key, token, token_exp, token_reviewer_jwt, uid_token].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  if @access_id.nil?
    invalid_properties.push('invalid value for "access_id", access_id cannot be nil.')
  end

  if @k8s_host.nil?
    invalid_properties.push('invalid value for "k8s_host", k8s_host cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @new_name.nil?
    invalid_properties.push('invalid value for "new_name", new_name cannot be nil.')
  end

  if @signing_key.nil?
    invalid_properties.push('invalid value for "signing_key", signing_key cannot be nil.')
  end

  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



316
317
318
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 316

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



322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 322

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



310
311
312
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 310

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



195
196
197
198
199
200
201
202
# File 'lib/akeyless/models/gateway_update_k8_s_auth_config.rb', line 195

def valid?
  return false if @access_id.nil?
  return false if @k8s_host.nil?
  return false if @name.nil?
  return false if @new_name.nil?
  return false if @signing_key.nil?
  true
end