Class: Akeyless::CreateClassicKey

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

Overview

CreateClassicKey is a command that creates classic key

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateClassicKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
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
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
 
# File 'lib/akeyless/models/create_classic_key.rb', line 109

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  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

#alg ⇒ Object

Classic Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, RSA1024, RSA2048, RSA3072, RSA4096, EC256, EC384, GPG]



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

def alg
  @alg
end

#cert_file_data ⇒ Object

Certificate in a PEM format.



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

def cert_file_data
  @cert_file_data
end

#delete_protection ⇒ Object

Protection from accidental deletion of this item



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#gpg_alg ⇒ Object

gpg alg: Relevant only if GPG key type selected; options: [RSA1024, RSA2048, RSA3072, RSA4096, Ed25519]



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

def gpg_alg
  @gpg_alg
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#key_data ⇒ Object

Base64-encoded classic key value



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

def key_data
  @key_data
end

#metadata ⇒ Object

Deprecated - use description



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

def metadata
  @metadata
end

#name ⇒ Object

ClassicKey name



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

def name
  @name
end

#protection_key_name ⇒ Object

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



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

def protection_key_name
  @protection_key_name
end

#tags ⇒ Object

List of the tags attached to this classic key



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

def tags
  @tags
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/akeyless/models/create_classic_key.rb', line 59

def self.attribute_map
  {
    :'alg' => :'alg',
    :'cert_file_data' => :'cert-file-data',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'gpg_alg' => :'gpg-alg',
    :'json' => :'json',
    :'key_data' => :'key-data',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'protection_key_name' => :'protection-key-name',
    :'tags' => :'tags',
    :'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



235
236
237
 
# File 'lib/akeyless/models/create_classic_key.rb', line 235

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/akeyless/models/create_classic_key.rb', line 83

def self.openapi_types
  {
    :'alg' => :'String',
    :'cert_file_data' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'gpg_alg' => :'String',
    :'json' => :'Boolean',
    :'key_data' => :'String',
    :'metadata' => :'String',
    :'name' => :'String',
    :'protection_key_name' => :'String',
    :'tags' => :'Array<String>',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/akeyless/models/create_classic_key.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alg == o.alg &&
      cert_file_data == o.cert_file_data &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      gpg_alg == o.gpg_alg &&
      json == o.json &&
      key_data == o.key_data &&
      metadata == o.metadata &&
      name == o.name &&
      protection_key_name == o.protection_key_name &&
      tags == o.tags &&
      token == o.token &&
      uid_token == o.uid_token
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



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

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/akeyless/models/create_classic_key.rb', line 337

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



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

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


222
223
224
 
# File 'lib/akeyless/models/create_classic_key.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



228
229
230
 
# File 'lib/akeyless/models/create_classic_key.rb', line 228

def hash
  [alg, cert_file_data, delete_protection, description, gpg_alg, json, key_data, metadata, name, protection_key_name, tags, 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



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/akeyless/models/create_classic_key.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @alg.nil?
    invalid_properties.push('invalid value for "alg", alg 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



313
314
315
 
# File 'lib/akeyless/models/create_classic_key.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/akeyless/models/create_classic_key.rb', line 319

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



307
308
309
 
# File 'lib/akeyless/models/create_classic_key.rb', line 307

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



194
195
196
197
198
 
# File 'lib/akeyless/models/create_classic_key.rb', line 194

def valid?
  return false if @alg.nil?
  return false if @name.nil?
  true
end