Class: Akeyless::GatewayPartialUpdateK8SAuthConfig

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayPartialUpdateK8SAuthConfig

Initializes the object



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 147

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::GatewayPartialUpdateK8SAuthConfig` 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::GatewayPartialUpdateK8SAuthConfig`. 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?(:'use_default_identity_bool')
    self.use_default_identity_bool = attributes[:'use_default_identity_bool']
  end

  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?(:'disable_issuer_validation')
    self.disable_issuer_validation = attributes[:'disable_issuer_validation']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

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

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

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

  if attributes.key?(:'k8s_client_key')
    self.k8s_client_key = attributes[:'k8s_client_key']
  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?(:'rancher_api_key')
    self.rancher_api_key = attributes[:'rancher_api_key']
  end

  if attributes.key?(:'rancher_cluster_id')
    self.rancher_cluster_id = attributes[:'rancher_cluster_id']
  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

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

Instance Attribute Details

#access_id ⇒ Object

The access ID of the Kubernetes auth method



21
22
23
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 21

def access_id
  @access_id
end

#config_encryption_key_name ⇒ Object

Config encryption key



24
25
26
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 24

def config_encryption_key_name
  @config_encryption_key_name
end

#disable_issuer_validation ⇒ Object

Disable issuer validation [true/false]



27
28
29
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 27

def disable_issuer_validation
  @disable_issuer_validation
end

#json ⇒ Object

Set output format to JSON



30
31
32
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 30

def json
  @json
end

#k8s_auth_type ⇒ Object

K8S auth type [token/certificate]. (relevant for "native_k8s" only)



33
34
35
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 33

def k8s_auth_type
  @k8s_auth_type
end

#k8s_ca_cert ⇒ Object

The CA Certificate (base64 encoded) to use to call into the kubernetes API server



36
37
38
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 36

def k8s_ca_cert
  @k8s_ca_cert
end

#k8s_client_certificate ⇒ Object

Content of the k8 client certificate (PEM format) in a Base64 format (relevant for "native_k8s" only)



39
40
41
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 39

def k8s_client_certificate
  @k8s_client_certificate
end

#k8s_client_key ⇒ Object

Content of the k8 client private key (PEM format) in a Base64 format (relevant for "native_k8s" only)



42
43
44
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 42

def k8s_client_key
  @k8s_client_key
end

#k8s_host ⇒ Object

The URL of the kubernetes API server



45
46
47
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 45

def k8s_host
  @k8s_host
end

#k8s_issuer ⇒ Object

The Kubernetes JWT issuer name. K8SIssuer is the claim that specifies who issued the Kubernetes token



48
49
50
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 48

def k8s_issuer
  @k8s_issuer
end

#name ⇒ Object

K8S Auth config name



51
52
53
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 51

def name
  @name
end

#new_name ⇒ Object

K8S Auth config new name



54
55
56
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 54

def new_name
  @new_name
end

#rancher_api_key ⇒ Object

The api key used to access the TokenReview API to validate other JWTs (relevant for "rancher" only)



57
58
59
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 57

def rancher_api_key
  @rancher_api_key
end

#rancher_cluster_id ⇒ Object

The cluster id as define in rancher (relevant for "rancher" only)



60
61
62
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 60

def rancher_cluster_id
  @rancher_cluster_id
end

#signing_key ⇒ Object

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



63
64
65
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 63

def signing_key
  @signing_key
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



66
67
68
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 66

def token
  @token
end

#token_exp ⇒ Object

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



69
70
71
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 69

def token_exp
  @token_exp
end

#token_reviewer_jwt ⇒ Object

A Kubernetes service account JWT used to access the TokenReview API to validate other JWTs (relevant for "native_k8s" only). If not set, the JWT submitted in the authentication process will be used to access the Kubernetes TokenReview API.



72
73
74
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 72

def token_reviewer_jwt
  @token_reviewer_jwt
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



75
76
77
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 75

def uid_token
  @uid_token
end

#use_default_identity_bool ⇒ Object

Returns the value of attribute use_default_identity_bool.



18
19
20
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 18

def use_default_identity_bool
  @use_default_identity_bool
end

#use_gw_service_account ⇒ Object

Use the GW’s service account



78
79
80
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 78

def 
  
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 331

def self._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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



108
109
110
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 81

def self.attribute_map
  {
    :'use_default_identity_bool' => :'UseDefaultIdentityBool',
    :'access_id' => :'access-id',
    :'config_encryption_key_name' => :'config-encryption-key-name',
    :'disable_issuer_validation' => :'disable-issuer-validation',
    :'json' => :'json',
    :'k8s_auth_type' => :'k8s-auth-type',
    :'k8s_ca_cert' => :'k8s-ca-cert',
    :'k8s_client_certificate' => :'k8s-client-certificate',
    :'k8s_client_key' => :'k8s-client-key',
    :'k8s_host' => :'k8s-host',
    :'k8s_issuer' => :'k8s-issuer',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'rancher_api_key' => :'rancher-api-key',
    :'rancher_cluster_id' => :'rancher-cluster-id',
    :'signing_key' => :'signing-key',
    :'token' => :'token',
    :'token_exp' => :'token-exp',
    :'token_reviewer_jwt' => :'token-reviewer-jwt',
    :'uid_token' => :'uid-token',
    :'use_gw_service_account' => :'use-gw-service-account'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 307

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 140

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 113

def self.openapi_types
  {
    :'use_default_identity_bool' => :'Boolean',
    :'access_id' => :'String',
    :'config_encryption_key_name' => :'String',
    :'disable_issuer_validation' => :'String',
    :'json' => :'Boolean',
    :'k8s_auth_type' => :'String',
    :'k8s_ca_cert' => :'String',
    :'k8s_client_certificate' => :'String',
    :'k8s_client_key' => :'String',
    :'k8s_host' => :'String',
    :'k8s_issuer' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'rancher_api_key' => :'String',
    :'rancher_cluster_id' => :'String',
    :'signing_key' => :'String',
    :'token' => :'String',
    :'token_exp' => :'Integer',
    :'token_reviewer_jwt' => :'String',
    :'uid_token' => :'String',
    :'use_gw_service_account' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      use_default_identity_bool == o.use_default_identity_bool &&
      access_id == o.access_id &&
      config_encryption_key_name == o.config_encryption_key_name &&
      disable_issuer_validation == o.disable_issuer_validation &&
      json == o.json &&
      k8s_auth_type == o.k8s_auth_type &&
      k8s_ca_cert == o.k8s_ca_cert &&
      k8s_client_certificate == o.k8s_client_certificate &&
      k8s_client_key == o.k8s_client_key &&
      k8s_host == o.k8s_host &&
      k8s_issuer == o.k8s_issuer &&
      name == o.name &&
      new_name == o.new_name &&
      rancher_api_key == o.rancher_api_key &&
      rancher_cluster_id == o.rancher_cluster_id &&
      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 &&
       == o.
end

#_to_hash(value) ⇒ Hash

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 402

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


294
295
296
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



300
301
302
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 300

def hash
  [use_default_identity_bool, access_id, config_encryption_key_name, disable_issuer_validation, json, k8s_auth_type, k8s_ca_cert, k8s_client_certificate, k8s_client_key, k8s_host, k8s_issuer, name, new_name, rancher_api_key, rancher_cluster_id, signing_key, token, token_exp, token_reviewer_jwt, uid_token, ].hash
end

#list_invalid_properties ⇒ Object

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



251
252
253
254
255
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 251

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



378
379
380
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 378

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 384

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_s ⇒ String

Returns the string representation of the object



372
373
374
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 372

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



259
260
261
262
 
# File 'lib/akeyless/models/gateway_partial_update_k8_s_auth_config.rb', line 259

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end