Class: Akeyless::DecryptFile

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DecryptFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
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
 
# File 'lib/akeyless/models/decrypt_file.rb', line 92

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_in ⇒ Object

Path to the file to be decrypted. If not provided, the content will be taken from stdin



24
25
26
 
# File 'lib/akeyless/models/decrypt_file.rb', line 24

def _in
  @_in
end

#cyphertext_header ⇒ Object

Returns the value of attribute cyphertext_header.



18
19
20
 
# File 'lib/akeyless/models/decrypt_file.rb', line 18

def cyphertext_header
  @cyphertext_header
end

#display_id ⇒ Object

The display id of the key to use in the decryption process



21
22
23
 
# File 'lib/akeyless/models/decrypt_file.rb', line 21

def display_id
  @display_id
end

#item_id ⇒ Object

The item id of the key to use in the decryption process



27
28
29
 
# File 'lib/akeyless/models/decrypt_file.rb', line 27

def item_id
  @item_id
end

#json ⇒ Object

Set output format to JSON



30
31
32
 
# File 'lib/akeyless/models/decrypt_file.rb', line 30

def json
  @json
end

#key_name ⇒ Object

The name of the key to use in the decryption process



33
34
35
 
# File 'lib/akeyless/models/decrypt_file.rb', line 33

def key_name
  @key_name
end

#out ⇒ Object

Path to the output file. If not provided, the output will be sent to stdout



36
37
38
 
# File 'lib/akeyless/models/decrypt_file.rb', line 36

def out
  @out
end

#token ⇒ Object

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



39
40
41
 
# File 'lib/akeyless/models/decrypt_file.rb', line 39

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



42
43
44
 
# File 'lib/akeyless/models/decrypt_file.rb', line 42

def uid_token
  @uid_token
end

#version ⇒ Object

key version (relevant only for classic key)



45
46
47
 
# File 'lib/akeyless/models/decrypt_file.rb', line 45

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/akeyless/models/decrypt_file.rb', line 233

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/akeyless/models/decrypt_file.rb', line 48

def self.attribute_map
  {
    :'cyphertext_header' => :'cyphertext-header',
    :'display_id' => :'display-id',
    :'_in' => :'in',
    :'item_id' => :'item-id',
    :'json' => :'json',
    :'key_name' => :'key-name',
    :'out' => :'out',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'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



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

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



85
86
87
88
 
# File 'lib/akeyless/models/decrypt_file.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/akeyless/models/decrypt_file.rb', line 69

def self.openapi_types
  {
    :'cyphertext_header' => :'String',
    :'display_id' => :'String',
    :'_in' => :'String',
    :'item_id' => :'Integer',
    :'json' => :'Boolean',
    :'key_name' => :'String',
    :'out' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cyphertext_header == o.cyphertext_header &&
      display_id == o.display_id &&
      _in == o._in &&
      item_id == o.item_id &&
      json == o.json &&
      key_name == o.key_name &&
      out == o.out &&
      token == o.token &&
      uid_token == o.uid_token &&
      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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/akeyless/models/decrypt_file.rb', line 304

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


196
197
198
 
# File 'lib/akeyless/models/decrypt_file.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/akeyless/models/decrypt_file.rb', line 202

def hash
  [cyphertext_header, display_id, _in, item_id, json, key_name, out, token, uid_token, 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



154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/akeyless/models/decrypt_file.rb', line 154

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



280
281
282
 
# File 'lib/akeyless/models/decrypt_file.rb', line 280

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/akeyless/models/decrypt_file.rb', line 286

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



274
275
276
 
# File 'lib/akeyless/models/decrypt_file.rb', line 274

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



170
171
172
173
174
175
 
# File 'lib/akeyless/models/decrypt_file.rb', line 170

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