Class: Akeyless::CreateGodaddyTarget

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

Overview

createGodaddyTarget is a command that creates a new target. [Deprecated: Use target-create-godaddy command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGodaddyTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

Instance Attribute Details

#api_keyObject

Key of the api credentials to the Godaddy account



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

def api_key
  @api_key
end

#descriptionObject

Description of the object



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

def description
  @description
end

#imap_fqdnObject

ImapFQDN of the IMAP service, FQDN or IPv4 address. Must be FQDN if the IMAP is using TLS



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

def imap_fqdn
  @imap_fqdn
end

#imap_passwordObject

ImapPassword to access the IMAP service



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

def imap_password
  @imap_password
end

#imap_portObject

ImapPort of the IMAP service



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

def imap_port
  @imap_port
end

#imap_usernameObject

ImapUsername to access the IMAP service



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

def imap_username
  @imap_username
end

#jsonObject

Set output format to JSON



38
39
40
# File 'lib/akeyless/models/create_godaddy_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_godaddy_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_godaddy_target.rb', line 44

def max_versions
  @max_versions
end

#nameObject

Target name



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

def name
  @name
end

#secretObject

Secret of the api credentials to the Godaddy account



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

def secret
  @secret
end

#timeoutObject

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



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

def timeout
  @timeout
end

#tokenObject

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



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

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



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

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/akeyless/models/create_godaddy_target.rb', line 307

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



82
83
84
# File 'lib/akeyless/models/create_godaddy_target.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/akeyless/models/create_godaddy_target.rb', line 62

def self.attribute_map
  {
    :'api_key' => :'api-key',
    :'description' => :'description',
    :'imap_fqdn' => :'imap-fqdn',
    :'imap_password' => :'imap-password',
    :'imap_port' => :'imap-port',
    :'imap_username' => :'imap-username',
    :'json' => :'json',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'secret' => :'secret',
    :'timeout' => :'timeout',
    :'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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/akeyless/models/create_godaddy_target.rb', line 283

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



107
108
109
110
# File 'lib/akeyless/models/create_godaddy_target.rb', line 107

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

.openapi_typesObject

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/akeyless/models/create_godaddy_target.rb', line 87

def self.openapi_types
  {
    :'api_key' => :'String',
    :'description' => :'String',
    :'imap_fqdn' => :'String',
    :'imap_password' => :'String',
    :'imap_port' => :'String',
    :'imap_username' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'secret' => :'String',
    :'timeout' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/akeyless/models/create_godaddy_target.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_key == o.api_key &&
      description == o.description &&
      imap_fqdn == o.imap_fqdn &&
      imap_password == o.imap_password &&
      imap_port == o.imap_port &&
      imap_username == o.imap_username &&
      json == o.json &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      secret == o.secret &&
      timeout == o.timeout &&
      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



378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'lib/akeyless/models/create_godaddy_target.rb', line 378

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


270
271
272
# File 'lib/akeyless/models/create_godaddy_target.rb', line 270

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



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

def hash
  [api_key, description, imap_fqdn, imap_password, imap_port, imap_username, json, key, max_versions, name, secret, timeout, token, uid_token].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
229
230
231
232
# File 'lib/akeyless/models/create_godaddy_target.rb', line 204

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

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

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

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

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

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



354
355
356
# File 'lib/akeyless/models/create_godaddy_target.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/akeyless/models/create_godaddy_target.rb', line 360

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



348
349
350
# File 'lib/akeyless/models/create_godaddy_target.rb', line 348

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



236
237
238
239
240
241
242
243
244
245
# File 'lib/akeyless/models/create_godaddy_target.rb', line 236

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @api_key.nil?
  return false if @imap_fqdn.nil?
  return false if @imap_password.nil?
  return false if @imap_username.nil?
  return false if @name.nil?
  return false if @secret.nil?
  true
end