Class: Akeyless::TargetUpdateDigiCert

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

Overview

targetUpdateDigiCert is a command that updates an existing DigiCert target

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetUpdateDigiCert

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'digicert_url')
    self.digicert_url = attributes[:'digicert_url']
  else
    self.digicert_url = 'us-production'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acme_challenge ⇒ Object

ACME challenge type. Options: [dns]



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

def acme_challenge
  @acme_challenge
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#digicert_url ⇒ Object

DigiCert ACME endpoint selector. Options: [us-production/eu-production/us-demo/eu-demo]



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

def digicert_url
  @digicert_url
end

#dns_target_creds ⇒ Object

Name of existing cloud target for DNS credentials. Required when challenge type is dns. Supported providers: AWS, Azure, GCP



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

def dns_target_creds
  @dns_target_creds
end

#eab_hmac_key ⇒ Object

External Account Binding HMAC key (required for ACME account bootstrap on create)



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

def eab_hmac_key
  @eab_hmac_key
end

#eab_key_id ⇒ Object

External Account Binding key identifier (required for ACME account bootstrap on create)



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

def eab_key_id
  @eab_key_id
end

#email ⇒ Object

Email address for ACME account registration



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

def email
  @email
end

#gcp_project ⇒ Object

GCP Cloud DNS project ID. Optional and can be derived from service account



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

def gcp_project
  @gcp_project
end

#hosted_zone ⇒ Object

AWS Route53 hosted zone ID. Required when DNS credentials target is AWS



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

def hosted_zone
  @hosted_zone
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#keep_prev_version ⇒ Object

Whether to keep previous version [true/false]. If not set, use default according to account settings



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

def keep_prev_version
  @keep_prev_version
end

#key ⇒ Object

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)



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

def key
  @key
end

#max_versions ⇒ Object

Set the maximum number of versions, limited by the account settings defaults.



56
57
58
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 56

def max_versions
  @max_versions
end

#name ⇒ Object

Target name



59
60
61
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 59

def name
  @name
end

#new_name ⇒ Object

New target name



62
63
64
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 62

def new_name
  @new_name
end

#resource_group ⇒ Object

Azure resource group name. Required when DNS credentials target is Azure



65
66
67
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 65

def resource_group
  @resource_group
end

#timeout ⇒ Object

Timeout for challenge validation



68
69
70
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 68

def timeout
  @timeout
end

#token ⇒ Object

Authentication token (see /auth and /configure)



71
72
73
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 71

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
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



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/target_update_digi_cert.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



102
103
104
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 77

def self.attribute_map
  {
    :'acme_challenge' => :'acme-challenge',
    :'description' => :'description',
    :'digicert_url' => :'digicert-url',
    :'dns_target_creds' => :'dns-target-creds',
    :'eab_hmac_key' => :'eab-hmac-key',
    :'eab_key_id' => :'eab-key-id',
    :'email' => :'email',
    :'gcp_project' => :'gcp-project',
    :'hosted_zone' => :'hosted-zone',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'resource_group' => :'resource-group',
    :'timeout' => :'timeout',
    :'token' => :'token',
    :'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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/akeyless/models/target_update_digi_cert.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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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/target_update_digi_cert.rb', line 107

def self.openapi_types
  {
    :'acme_challenge' => :'String',
    :'description' => :'String',
    :'digicert_url' => :'String',
    :'dns_target_creds' => :'String',
    :'eab_hmac_key' => :'String',
    :'eab_key_id' => :'String',
    :'email' => :'String',
    :'gcp_project' => :'String',
    :'hosted_zone' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'resource_group' => :'String',
    :'timeout' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/target_update_digi_cert.rb', line 268

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acme_challenge == o.acme_challenge &&
      description == o.description &&
      digicert_url == o.digicert_url &&
      dns_target_creds == o.dns_target_creds &&
      eab_hmac_key == o.eab_hmac_key &&
      eab_key_id == o.eab_key_id &&
      email == o.email &&
      gcp_project == o.gcp_project &&
      hosted_zone == o.hosted_zone &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      new_name == o.new_name &&
      resource_group == o.resource_group &&
      timeout == o.timeout &&
      token == o.token &&
      uid_token == o.uid_token
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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/akeyless/models/target_update_digi_cert.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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [acme_challenge, description, digicert_url, dns_target_creds, eab_hmac_key, eab_key_id, email, gcp_project, hosted_zone, json, keep_prev_version, key, max_versions, name, new_name, resource_group, timeout, token, uid_token].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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 243

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

  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



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

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/akeyless/models/target_update_digi_cert.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

Returns:

  • (String) —

    String presentation of the object



372
373
374
 
# File 'lib/akeyless/models/target_update_digi_cert.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

Returns:

  • (Boolean) —

    true if the model is valid



259
260
261
262
263
264
 
# File 'lib/akeyless/models/target_update_digi_cert.rb', line 259

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