Class: Akeyless::GatewayCreateProducerGcp

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

Overview

gatewayCreateProducerGcp is a command that creates a GCP producer [Deprecated: Use dynamic-secret-create-gcp command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayCreateProducerGcp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 177

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

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

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

  if attributes.key?(:'fixed_user_claim_keyname')
    self.fixed_user_claim_keyname = attributes[:'fixed_user_claim_keyname']
  else
    self.fixed_user_claim_keyname = 'ext_email'
  end

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

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

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

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

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

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

  if attributes.key?(:'item_custom_fields')
    if (value = attributes[:'item_custom_fields']).is_a?(Hash)
      self.item_custom_fields = value
    end
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'service_account_type')
    self. = attributes[:'service_account_type']
  else
    self. = 'fixed'
  end

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

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

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

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

  if attributes.key?(:'user_ttl')
    self.user_ttl = attributes[:'user_ttl']
  else
    self.user_ttl = '60m'
  end
end

Instance Attribute Details

#access_type ⇒ Object

Returns the value of attribute access_type.



19
20
21
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 19

def access_type
  @access_type
end

#custom_username_template ⇒ Object

Customize how temporary usernames are generated using go template



22
23
24
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 22

def custom_username_template
  @custom_username_template
end

#delete_protection ⇒ Object

Protection from accidental deletion of this object [true/false]



25
26
27
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 25

def delete_protection
  @delete_protection
end

#fixed_user_claim_keyname ⇒ Object

For externally provided users, denotes the key-name of IdP claim to extract the username from (Relevant only when –access-type=external)



28
29
30
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 28

def fixed_user_claim_keyname
  @fixed_user_claim_keyname
end

#gcp_cred_type ⇒ Object

Returns the value of attribute gcp_cred_type.



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

def gcp_cred_type
  @gcp_cred_type
end

#gcp_key ⇒ Object

Base64-encoded service account private key text



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

def gcp_key
  @gcp_key
end

#gcp_key_algo ⇒ Object

Service account key algorithm, e.g. KEY_ALG_RSA_1024 (Relevant only when –access-type=sa and –gcp-cred-type=key)



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

def gcp_key_algo
  @gcp_key_algo
end

#gcp_project_id ⇒ Object

GCP Project ID override for dynamic secret operations



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

def gcp_project_id
  @gcp_project_id
end

#gcp_sa_email ⇒ Object

The email of the fixed service account to generate keys or tokens for (Relevant only when –access-type=sa and –service-account-type=fixed)



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

def gcp_sa_email
  @gcp_sa_email
end

#gcp_token_scopes ⇒ Object

Access token scopes list, e.g. scope1,scope2 (Relevant only when –access-type=sa; required when –gcp-cred-type=token)



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

def gcp_token_scopes
  @gcp_token_scopes
end

#item_custom_fields ⇒ Object

Additional custom fields to associate with the item



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

def item_custom_fields
  @item_custom_fields
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#name ⇒ Object

Dynamic secret name



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

def name
  @name
end

#producer_encryption_key_name ⇒ Object

Dynamic producer encryption key



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

def producer_encryption_key_name
  @producer_encryption_key_name
end

#role_binding ⇒ Object

Role binding definitions in JSON format (Relevant only when –access-type=sa and –service-account-type=dynamic)



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

def role_binding
  @role_binding
end

#role_names ⇒ Object

Comma-separated list of GCP roles to assign to the user (Relevant only when –access-type=external)



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

def role_names
  @role_names
end

#secure_access_delay ⇒ Object

The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds



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

def secure_access_delay
  @secure_access_delay
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



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

def secure_access_enable
  @secure_access_enable
end

#secure_access_url ⇒ Object

Destination URL to inject secrets



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

def secure_access_url
  @secure_access_url
end

#secure_access_web_browsing ⇒ Object

Secure browser via Akeyless’s Secure Remote Access (SRA)



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

def secure_access_web_browsing
  @secure_access_web_browsing
end

#secure_access_web_proxy ⇒ Object

Web-Proxy via Akeyless’s Secure Remote Access (SRA)



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

def secure_access_web_proxy
  @secure_access_web_proxy
end

#service_account_type ⇒ Object

The type of the GCP service account. Options [fixed, dynamic] (Relevant only when –access-type=sa)



81
82
83
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 81

def 
  
end

#tags ⇒ Object

Add tags attached to this object



84
85
86
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 84

def tags
  @tags
end

#target_name ⇒ Object

Target name



87
88
89
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 87

def target_name
  @target_name
end

#token ⇒ Object

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



90
91
92
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 90

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



93
94
95
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 93

def uid_token
  @uid_token
end

#user_ttl ⇒ Object

User TTL



96
97
98
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 96

def user_ttl
  @user_ttl
end

Class Method Details

._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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 410

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



132
133
134
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 132

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



99
100
101
102
103
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
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 99

def self.attribute_map
  {
    :'access_type' => :'access-type',
    :'custom_username_template' => :'custom-username-template',
    :'delete_protection' => :'delete_protection',
    :'fixed_user_claim_keyname' => :'fixed-user-claim-keyname',
    :'gcp_cred_type' => :'gcp-cred-type',
    :'gcp_key' => :'gcp-key',
    :'gcp_key_algo' => :'gcp-key-algo',
    :'gcp_project_id' => :'gcp-project-id',
    :'gcp_sa_email' => :'gcp-sa-email',
    :'gcp_token_scopes' => :'gcp-token-scopes',
    :'item_custom_fields' => :'item-custom-fields',
    :'json' => :'json',
    :'name' => :'name',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'role_binding' => :'role-binding',
    :'role_names' => :'role-names',
    :'secure_access_delay' => :'secure-access-delay',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_url' => :'secure-access-url',
    :'secure_access_web_browsing' => :'secure-access-web-browsing',
    :'secure_access_web_proxy' => :'secure-access-web-proxy',
    :'service_account_type' => :'service-account-type',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'user_ttl' => :'user-ttl'
  }
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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 386

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



170
171
172
173
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 170

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'access_type' => :'String',
    :'custom_username_template' => :'String',
    :'delete_protection' => :'String',
    :'fixed_user_claim_keyname' => :'String',
    :'gcp_cred_type' => :'String',
    :'gcp_key' => :'String',
    :'gcp_key_algo' => :'String',
    :'gcp_project_id' => :'String',
    :'gcp_sa_email' => :'String',
    :'gcp_token_scopes' => :'String',
    :'item_custom_fields' => :'Hash<String, String>',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'role_binding' => :'String',
    :'role_names' => :'String',
    :'secure_access_delay' => :'Integer',
    :'secure_access_enable' => :'String',
    :'secure_access_url' => :'String',
    :'secure_access_web_browsing' => :'Boolean',
    :'secure_access_web_proxy' => :'Boolean',
    :'service_account_type' => :'String',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_ttl' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
369
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_type == o.access_type &&
      custom_username_template == o.custom_username_template &&
      delete_protection == o.delete_protection &&
      fixed_user_claim_keyname == o.fixed_user_claim_keyname &&
      gcp_cred_type == o.gcp_cred_type &&
      gcp_key == o.gcp_key &&
      gcp_key_algo == o.gcp_key_algo &&
      gcp_project_id == o.gcp_project_id &&
      gcp_sa_email == o.gcp_sa_email &&
      gcp_token_scopes == o.gcp_token_scopes &&
      item_custom_fields == o.item_custom_fields &&
      json == o.json &&
      name == o.name &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      role_binding == o.role_binding &&
      role_names == o.role_names &&
      secure_access_delay == o.secure_access_delay &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_url == o.secure_access_url &&
      secure_access_web_browsing == o.secure_access_web_browsing &&
      secure_access_web_proxy == o.secure_access_web_proxy &&
       == o. &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_ttl == o.user_ttl
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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 481

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


373
374
375
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 373

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



379
380
381
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 379

def hash
  [access_type, custom_username_template, delete_protection, fixed_user_claim_keyname, gcp_cred_type, gcp_key, gcp_key_algo, gcp_project_id, gcp_sa_email, gcp_token_scopes, item_custom_fields, json, name, producer_encryption_key_name, role_binding, role_names, secure_access_delay, secure_access_enable, secure_access_url, secure_access_web_browsing, secure_access_web_proxy, , tags, target_name, token, uid_token, user_ttl].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



319
320
321
322
323
324
325
326
327
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 319

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



457
458
459
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 457

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 463

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

Returns:

  • (String) —

    String presentation of the object



451
452
453
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 451

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



331
332
333
334
335
 
# File 'lib/akeyless/models/gateway_create_producer_gcp.rb', line 331

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  true
end