Class: Akeyless::TargetUpdateGlobalSign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetUpdateGlobalSign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
220
221
222
223
224
225
226
227
228
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = '5m'
  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?(:'username')
    self.username = attributes[:'username']
  else
    self.username = nil
  end
end

Instance Attribute Details

#contact_email ⇒ Object

Email of the GlobalSign GCC account contact



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

def contact_email
  @contact_email
end

#contact_first_name ⇒ Object

First name of the GlobalSign GCC account contact



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

def contact_first_name
  @contact_first_name
end

#contact_last_name ⇒ Object

Last name of the GlobalSign GCC account contact



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

def contact_last_name
  @contact_last_name
end

#contact_phone ⇒ Object

Telephone of the GlobalSign GCC account contact



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

def contact_phone
  @contact_phone
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#keep_prev_version ⇒ Object

Whether to keep previous version [true/false]. If not set, use default according to account settings



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

def keep_prev_version
  @keep_prev_version
end

#key ⇒ Object

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



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

def key
  @key
end

#max_versions ⇒ Object

Set the maximum number of versions, limited by the account settings defaults.



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

def max_versions
  @max_versions
end

#name ⇒ Object

Target name



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

def name
  @name
end

#new_name ⇒ Object

New target name



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

def new_name
  @new_name
end

#password ⇒ Object

Password of the GlobalSign GCC account



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

def password
  @password
end

#profile_id ⇒ Object

Profile ID of the GlobalSign GCC account



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

def profile_id
  @profile_id
end

#timeout ⇒ Object

Timeout waiting for certificate validation in Duration format (1h - 1 Hour, 20m - 20 Minutes, 33m3s - 33 Minutes and 3 Seconds), maximum 1h.



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

def timeout
  @timeout
end

#token ⇒ Object

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



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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
end

#username ⇒ Object

Username of the GlobalSign GCC account



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

def username
  @username
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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 348

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 70

def self.attribute_map
  {
    :'contact_email' => :'contact-email',
    :'contact_first_name' => :'contact-first-name',
    :'contact_last_name' => :'contact-last-name',
    :'contact_phone' => :'contact-phone',
    :'description' => :'description',
    :'json' => :'json',
    :'keep_prev_version' => :'keep-prev-version',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'new_name' => :'new-name',
    :'password' => :'password',
    :'profile_id' => :'profile-id',
    :'timeout' => :'timeout',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'username' => :'username'
  }
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 324

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



121
122
123
124
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 98

def self.openapi_types
  {
    :'contact_email' => :'String',
    :'contact_first_name' => :'String',
    :'contact_last_name' => :'String',
    :'contact_phone' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'keep_prev_version' => :'String',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'new_name' => :'String',
    :'password' => :'String',
    :'profile_id' => :'String',
    :'timeout' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact_email == o.contact_email &&
      contact_first_name == o.contact_first_name &&
      contact_last_name == o.contact_last_name &&
      contact_phone == o.contact_phone &&
      description == o.description &&
      json == o.json &&
      keep_prev_version == o.keep_prev_version &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      new_name == o.new_name &&
      password == o.password &&
      profile_id == o.profile_id &&
      timeout == o.timeout &&
      token == o.token &&
      uid_token == o.uid_token &&
      username == o.username
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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 419

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


311
312
313
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 317

def hash
  [contact_email, contact_first_name, contact_last_name, contact_phone, description, json, keep_prev_version, key, max_versions, name, new_name, password, profile_id, timeout, token, uid_token, username].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



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

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

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

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

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

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

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

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

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



395
396
397
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 395

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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 401

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



389
390
391
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 389

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



272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/akeyless/models/target_update_global_sign.rb', line 272

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @contact_email.nil?
  return false if @contact_first_name.nil?
  return false if @contact_last_name.nil?
  return false if @contact_phone.nil?
  return false if @name.nil?
  return false if @password.nil?
  return false if @profile_id.nil?
  return false if @username.nil?
  true
end