Class: Akeyless::SignPKICertWithClassicKey

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignPKICertWithClassicKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

  if attributes.key?(:'key_usage')
    self.key_usage = attributes[:'key_usage']
  else
    self.key_usage = 'DigitalSignature,KeyAgreement,KeyEncipherment'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#common_name ⇒ Object

The common name to be included in the PKI certificate



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

def common_name
  @common_name
end

#country ⇒ Object

A comma-separated list of the country that will be set in the issued certificate



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

def country
  @country
end

#display_id ⇒ Object

The name of the key to use in the sign PKI Cert process



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

def display_id
  @display_id
end

#dns_names ⇒ Object

DNS Names to be included in the PKI certificate (in a comma-delimited list)



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

def dns_names
  @dns_names
end

#json ⇒ Object

Set output format to JSON



31
32
33
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 31

def json
  @json
end

#key_usage ⇒ Object

key-usage



34
35
36
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 34

def key_usage
  @key_usage
end

#locality ⇒ Object

A comma-separated list of the locality that will be set in the issued certificate



37
38
39
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 37

def locality
  @locality
end

#organizational_units ⇒ Object

A comma-separated list of organizational units (OU) that will be set in the issued certificate



40
41
42
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 40

def organizational_units
  @organizational_units
end

#organizations ⇒ Object

A comma-separated list of organizations (O) that will be set in the issued certificate



43
44
45
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 43

def organizations
  @organizations
end

#postal_code ⇒ Object

A comma-separated list of the postal code that will be set in the issued certificate



46
47
48
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 46

def postal_code
  @postal_code
end

#province ⇒ Object

A comma-separated list of the province that will be set in the issued certificate



49
50
51
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 49

def province
  @province
end

#public_key_pem_data ⇒ Object

PublicKey using for signing in a PEM format.



52
53
54
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 52

def public_key_pem_data
  @public_key_pem_data
end

#signing_method ⇒ Object

SigningMethod



55
56
57
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 55

def signing_method
  @signing_method
end

#street_address ⇒ Object

A comma-separated list of the street address that will be set in the issued certificate



58
59
60
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 58

def street_address
  @street_address
end

#token ⇒ Object

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



61
62
63
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 61

def token
  @token
end

#ttl ⇒ Object

he requested Time To Live for the certificate, in seconds



64
65
66
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 64

def ttl
  @ttl
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



67
68
69
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 67

def uid_token
  @uid_token
end

#uri_sans ⇒ Object

The URI Subject Alternative Names to be included in the PKI certificate (in a comma-delimited list)



70
71
72
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 70

def uri_sans
  @uri_sans
end

#version ⇒ Object

classic key version



73
74
75
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 73

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



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
370
371
372
373
374
375
376
377
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 340

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



101
102
103
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'common_name' => :'common-name',
    :'country' => :'country',
    :'display_id' => :'display-id',
    :'dns_names' => :'dns-names',
    :'json' => :'json',
    :'key_usage' => :'key-usage',
    :'locality' => :'locality',
    :'organizational_units' => :'organizational-units',
    :'organizations' => :'organizations',
    :'postal_code' => :'postal-code',
    :'province' => :'province',
    :'public_key_pem_data' => :'public-key-pem-data',
    :'signing_method' => :'signing-method',
    :'street_address' => :'street-address',
    :'token' => :'token',
    :'ttl' => :'ttl',
    :'uid_token' => :'uid-token',
    :'uri_sans' => :'uri-sans',
    :'version' => :'version'
  }
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 316

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 106

def self.openapi_types
  {
    :'common_name' => :'String',
    :'country' => :'String',
    :'display_id' => :'String',
    :'dns_names' => :'String',
    :'json' => :'Boolean',
    :'key_usage' => :'String',
    :'locality' => :'String',
    :'organizational_units' => :'String',
    :'organizations' => :'String',
    :'postal_code' => :'String',
    :'province' => :'String',
    :'public_key_pem_data' => :'String',
    :'signing_method' => :'String',
    :'street_address' => :'String',
    :'token' => :'String',
    :'ttl' => :'Integer',
    :'uid_token' => :'String',
    :'uri_sans' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      common_name == o.common_name &&
      country == o.country &&
      display_id == o.display_id &&
      dns_names == o.dns_names &&
      json == o.json &&
      key_usage == o.key_usage &&
      locality == o.locality &&
      organizational_units == o.organizational_units &&
      organizations == o.organizations &&
      postal_code == o.postal_code &&
      province == o.province &&
      public_key_pem_data == o.public_key_pem_data &&
      signing_method == o.signing_method &&
      street_address == o.street_address &&
      token == o.token &&
      ttl == o.ttl &&
      uid_token == o.uid_token &&
      uri_sans == o.uri_sans &&
      version == o.version
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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 411

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


303
304
305
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



309
310
311
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 309

def hash
  [common_name, country, display_id, dns_names, json, key_usage, locality, organizational_units, organizations, postal_code, province, public_key_pem_data, signing_method, street_address, token, ttl, uid_token, uri_sans, version].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



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

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

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

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

  if @version.nil?
    invalid_properties.push('invalid value for "version", version 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



387
388
389
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 387

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 393

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



381
382
383
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 381

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



266
267
268
269
270
271
272
273
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 266

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