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



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

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']
  end

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

#key_usage ⇒ Object

key-usage



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

def key_usage
  @key_usage
end

#locality ⇒ Object

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



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

def locality
  @locality
end

#organizational_units ⇒ Object

A comma-separated list of organizational units (OU) 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 organizational_units
  @organizational_units
end

#organizations ⇒ Object

A comma-separated list of organizations (O) 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 organizations
  @organizations
end

#postal_code ⇒ Object

A comma-separated list of the postal code 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 postal_code
  @postal_code
end

#province ⇒ Object

A comma-separated list of the province 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 province
  @province
end

#public_key_pem_data ⇒ Object

PublicKey using for signing in a PEM format.



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

def public_key_pem_data
  @public_key_pem_data
end

#signing_method ⇒ Object

SigningMethod



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

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



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

def street_address
  @street_address
end

#token ⇒ Object

Authentication token (see /auth and /configure)



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

def token
  @token
end

#ttl ⇒ Object

he requested Time To Live for the certificate, in seconds



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

def ttl
  @ttl
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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)



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

def uri_sans
  @uri_sans
end

#version ⇒ Object

classic key version



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

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'common_name' => :'common-name',
    :'country' => :'country',
    :'display_id' => :'display-id',
    :'dns_names' => :'dns-names',
    :'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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 102

def self.openapi_types
  {
    :'common_name' => :'String',
    :'country' => :'String',
    :'display_id' => :'String',
    :'dns_names' => :'String',
    :'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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 256

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 &&
      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

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



325
326
327
328
329
330
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
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 325

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 396

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 301

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


281
282
283
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 287

def hash
  [common_name, country, display_id, dns_names, 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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 223

def list_invalid_properties
  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



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

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 378

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



366
367
368
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 366

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



246
247
248
249
250
251
252
 
# File 'lib/akeyless/models/sign_pki_cert_with_classic_key.rb', line 246

def valid?
  return false if @display_id.nil?
  return false if @signing_method.nil?
  return false if @ttl.nil?
  return false if @version.nil?
  true
end