Class: Akeyless::UploadPKCS12

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UploadPKCS12

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/upload_pkcs12.rb', line 103

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

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

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

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

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

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

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

#_in ⇒ Object

PKCS#12 input file (private key and certificate only)



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

def _in
  @_in
end

#customer_frg_id ⇒ Object

The customer fragment ID that will be used to split the key (if empty, the key will be created independently of a customer fragment)



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

def customer_frg_id
  @customer_frg_id
end

#delete_protection ⇒ Object

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



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#metadata ⇒ Object

Deprecated - use description



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

def metadata
  @metadata
end

#name ⇒ Object

Name of key to be created



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

def name
  @name
end

#passphrase ⇒ Object

Passphrase to unlock the pkcs#12 bundle



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

def passphrase
  @passphrase
end

#split_level ⇒ Object

The number of fragments that the item will be split into



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

def split_level
  @split_level
end

#tag ⇒ Object

List of the tags attached to this key



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

def tag
  @tag
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 55

def self.attribute_map
  {
    :'customer_frg_id' => :'customer-frg-id',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'_in' => :'in',
    :'json' => :'json',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'passphrase' => :'passphrase',
    :'split_level' => :'split-level',
    :'tag' => :'tag',
    :'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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 78

def self.openapi_types
  {
    :'customer_frg_id' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'_in' => :'String',
    :'json' => :'Boolean',
    :'metadata' => :'String',
    :'name' => :'String',
    :'passphrase' => :'String',
    :'split_level' => :'Integer',
    :'tag' => :'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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_frg_id == o.customer_frg_id &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      _in == o._in &&
      json == o.json &&
      metadata == o.metadata &&
      name == o.name &&
      passphrase == o.passphrase &&
      split_level == o.split_level &&
      tag == o.tag &&
      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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 234

def hash
  [customer_frg_id, delete_protection, description, _in, json, metadata, name, passphrase, split_level, tag, 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
191
192
193
194
195
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 179

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

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

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



312
313
314
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 312

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



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

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



306
307
308
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 306

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



199
200
201
202
203
204
205
 
# File 'lib/akeyless/models/upload_pkcs12.rb', line 199

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