Class: Akeyless::GatewayMigratePersonalItems

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

Overview

gatewayMigratePersonalItems is a command that migrate personal items from external vault

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayMigratePersonalItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 99

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

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

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

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

  if attributes.key?(:'_1password_vaults')
    if (value = attributes[:'_1password_vaults']).is_a?(Array)
      self._1password_vaults = value
    end
  end

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = '1password'
  end

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

Instance Attribute Details

#_1password_email ⇒ Object

1Password user email to connect to the API



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

def _1password_email
  @_1password_email
end

#_1password_password ⇒ Object

1Password user password to connect to the API



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

def _1password_password
  @_1password_password
end

#_1password_secret_key ⇒ Object

1Password user secret key to connect to the API



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

def _1password_secret_key
  @_1password_secret_key
end

#_1password_url ⇒ Object

1Password api container url



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

def _1password_url
  @_1password_url
end

#_1password_vaults ⇒ Object

1Password list of vault to get the items from



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

def _1password_vaults
  @_1password_vaults
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#protection_key ⇒ Object

The name of a key that used to encrypt the secret value



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

def protection_key
  @protection_key
end

#target_location ⇒ Object

Target location in your Akeyless personal folder for migrated secrets



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

def target_location
  @target_location
end

#token ⇒ Object

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



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

def token
  @token
end

#type ⇒ Object

Migration type for now only 1password.



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

def type
  @type
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

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



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
271
272
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 235

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 53

def self.attribute_map
  {
    :'_1password_email' => :'1password-email',
    :'_1password_password' => :'1password-password',
    :'_1password_secret_key' => :'1password-secret-key',
    :'_1password_url' => :'1password-url',
    :'_1password_vaults' => :'1password-vaults',
    :'json' => :'json',
    :'protection_key' => :'protection-key',
    :'target_location' => :'target-location',
    :'token' => :'token',
    :'type' => :'type',
    :'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



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

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



92
93
94
95
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 75

def self.openapi_types
  {
    :'_1password_email' => :'String',
    :'_1password_password' => :'String',
    :'_1password_secret_key' => :'String',
    :'_1password_url' => :'String',
    :'_1password_vaults' => :'Array<String>',
    :'json' => :'Boolean',
    :'protection_key' => :'String',
    :'target_location' => :'String',
    :'token' => :'String',
    :'type' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _1password_email == o._1password_email &&
      _1password_password == o._1password_password &&
      _1password_secret_key == o._1password_secret_key &&
      _1password_url == o._1password_url &&
      _1password_vaults == o._1password_vaults &&
      json == o.json &&
      protection_key == o.protection_key &&
      target_location == o.target_location &&
      token == o.token &&
      type == o.type &&
      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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 306

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


198
199
200
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 204

def hash
  [_1password_email, _1password_password, _1password_secret_key, _1password_url, _1password_vaults, json, protection_key, target_location, token, type, 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



165
166
167
168
169
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 165

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



282
283
284
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 288

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



276
277
278
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 276

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



173
174
175
176
 
# File 'lib/akeyless/models/gateway_migrate_personal_items.rb', line 173

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end