Class: Akeyless::CreateGlobalSignTarget

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

Overview

createGlobalSignTarget is a command that creates a new target. [Deprecated: Use target-create-globalsign command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGlobalSignTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  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?(:'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?(:'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

#commentObject

Deprecated - use description



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

def comment
  @comment
end

#contact_emailObject

Email of the GlobalSign GCC account contact



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

def contact_email
  @contact_email
end

#contact_first_nameObject

First name of the GlobalSign GCC account contact



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

def contact_first_name
  @contact_first_name
end

#contact_last_nameObject

Last name of the GlobalSign GCC account contact



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

def contact_last_name
  @contact_last_name
end

#contact_phoneObject

Telephone of the GlobalSign GCC account contact



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

def contact_phone
  @contact_phone
end

#descriptionObject

Description of the object



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

def description
  @description
end

#jsonObject

Set output format to JSON



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

def json
  @json
end

#keyObject

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



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

def key
  @key
end

#max_versionsObject

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



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

def max_versions
  @max_versions
end

#nameObject

Target name



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

def name
  @name
end

#passwordObject

Password of the GlobalSign GCC account



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

def password
  @password
end

#profile_idObject

Profile ID of the GlobalSign GCC account



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

def profile_id
  @profile_id
end

#timeoutObject

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



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

def timeout
  @timeout
end

#tokenObject

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



59
60
61
# File 'lib/akeyless/models/create_global_sign_target.rb', line 59

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



62
63
64
# File 'lib/akeyless/models/create_global_sign_target.rb', line 62

def uid_token
  @uid_token
end

#usernameObject

Username of the GlobalSign GCC account



65
66
67
# File 'lib/akeyless/models/create_global_sign_target.rb', line 65

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



339
340
341
342
343
344
345
346
347
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
# File 'lib/akeyless/models/create_global_sign_target.rb', line 339

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_attributesObject

Returns all the JSON keys this model knows about



90
91
92
# File 'lib/akeyless/models/create_global_sign_target.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'comment' => :'comment',
    :'contact_email' => :'contact-email',
    :'contact_first_name' => :'contact-first-name',
    :'contact_last_name' => :'contact-last-name',
    :'contact_phone' => :'contact-phone',
    :'description' => :'description',
    :'json' => :'json',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/akeyless/models/create_global_sign_target.rb', line 315

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_nullableObject

List of attributes with nullable: true



117
118
119
120
# File 'lib/akeyless/models/create_global_sign_target.rb', line 117

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

.openapi_typesObject

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/akeyless/models/create_global_sign_target.rb', line 95

def self.openapi_types
  {
    :'comment' => :'String',
    :'contact_email' => :'String',
    :'contact_first_name' => :'String',
    :'contact_last_name' => :'String',
    :'contact_phone' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/akeyless/models/create_global_sign_target.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comment == o.comment &&
      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 &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.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



410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/akeyless/models/create_global_sign_target.rb', line 410

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


302
303
304
# File 'lib/akeyless/models/create_global_sign_target.rb', line 302

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



308
309
310
# File 'lib/akeyless/models/create_global_sign_target.rb', line 308

def hash
  [comment, contact_email, contact_first_name, contact_last_name, contact_phone, description, json, key, max_versions, name, password, profile_id, timeout, token, uid_token, username].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



224
225
226
227
228
229
230
231
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
# File 'lib/akeyless/models/create_global_sign_target.rb', line 224

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



386
387
388
# File 'lib/akeyless/models/create_global_sign_target.rb', line 386

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
401
402
403
404
# File 'lib/akeyless/models/create_global_sign_target.rb', line 392

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



380
381
382
# File 'lib/akeyless/models/create_global_sign_target.rb', line 380

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



264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/akeyless/models/create_global_sign_target.rb', line 264

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