Class: Akeyless::GatewayCreateProducerRdp

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

Overview

gatewayCreateProducerRdp is a command that creates rdp producer

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayCreateProducerRdp

Initializes the object



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'target_name')
    self.target_name = attributes[:'target_name']
  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?(:'user_ttl')
    self.user_ttl = attributes[:'user_ttl']
  else
    self.user_ttl = '60m'
  end

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

Instance Attribute Details

#allow_user_extend_sessionObject

AllowUserExtendSession



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

def allow_user_extend_session
  @allow_user_extend_session
end

#delete_protectionObject

Protection from accidental deletion of this item



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

def delete_protection
  @delete_protection
end

#fixed_user_onlyObject

Fixed user



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

def fixed_user_only
  @fixed_user_only
end

#jsonObject

Set output format to JSON



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

def json
  @json
end

#nameObject

Producer name



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

def name
  @name
end

#producer_encryption_key_nameObject

Dynamic producer encryption key



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

def producer_encryption_key_name
  @producer_encryption_key_name
end

#rdp_admin_nameObject

RDP Admin Name



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

def rdp_admin_name
  @rdp_admin_name
end

#rdp_admin_pwdObject

RDP Admin password



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

def rdp_admin_pwd
  @rdp_admin_pwd
end

#rdp_host_nameObject

Hostname



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

def rdp_host_name
  @rdp_host_name
end

#rdp_host_portObject

Port



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

def rdp_host_port
  @rdp_host_port
end

#rdp_user_groupsObject

Groups



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

def rdp_user_groups
  @rdp_user_groups
end

#secure_access_allow_external_userObject

Returns the value of attribute secure_access_allow_external_user.



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

def secure_access_allow_external_user
  @secure_access_allow_external_user
end

#secure_access_enableObject

Returns the value of attribute secure_access_enable.



54
55
56
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 54

def secure_access_enable
  @secure_access_enable
end

#secure_access_hostObject

Returns the value of attribute secure_access_host.



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

def secure_access_host
  @secure_access_host
end

#secure_access_rdp_domainObject

Returns the value of attribute secure_access_rdp_domain.



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

def secure_access_rdp_domain
  @secure_access_rdp_domain
end

#secure_access_rdp_userObject

Returns the value of attribute secure_access_rdp_user.



60
61
62
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 60

def secure_access_rdp_user
  @secure_access_rdp_user
end

#tagsObject

List of the tags attached to this secret



63
64
65
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 63

def tags
  @tags
end

#target_nameObject

Target name



66
67
68
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 66

def target_name
  @target_name
end

#tokenObject

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



69
70
71
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 69

def token
  @token
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



72
73
74
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 72

def uid_token
  @uid_token
end

#user_ttlObject

User TTL



75
76
77
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 75

def user_ttl
  @user_ttl
end

#warn_user_before_expirationObject

WarnBeforeUserExpiration



78
79
80
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 78

def warn_user_before_expiration
  @warn_user_before_expiration
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



109
110
111
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 81

def self.attribute_map
  {
    :'allow_user_extend_session' => :'allow-user-extend-session',
    :'delete_protection' => :'delete_protection',
    :'fixed_user_only' => :'fixed-user-only',
    :'json' => :'json',
    :'name' => :'name',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'rdp_admin_name' => :'rdp-admin-name',
    :'rdp_admin_pwd' => :'rdp-admin-pwd',
    :'rdp_host_name' => :'rdp-host-name',
    :'rdp_host_port' => :'rdp-host-port',
    :'rdp_user_groups' => :'rdp-user-groups',
    :'secure_access_allow_external_user' => :'secure-access-allow-external-user',
    :'secure_access_enable' => :'secure-access-enable',
    :'secure_access_host' => :'secure-access-host',
    :'secure_access_rdp_domain' => :'secure-access-rdp-domain',
    :'secure_access_rdp_user' => :'secure-access-rdp-user',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'user_ttl' => :'user-ttl',
    :'warn_user_before_expiration' => :'warn-user-before-expiration'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



323
324
325
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 323

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



142
143
144
145
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 142

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'allow_user_extend_session' => :'Integer',
    :'delete_protection' => :'String',
    :'fixed_user_only' => :'String',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'rdp_admin_name' => :'String',
    :'rdp_admin_pwd' => :'String',
    :'rdp_host_name' => :'String',
    :'rdp_host_port' => :'String',
    :'rdp_user_groups' => :'String',
    :'secure_access_allow_external_user' => :'Boolean',
    :'secure_access_enable' => :'String',
    :'secure_access_host' => :'Array<String>',
    :'secure_access_rdp_domain' => :'String',
    :'secure_access_rdp_user' => :'String',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_ttl' => :'String',
    :'warn_user_before_expiration' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_user_extend_session == o.allow_user_extend_session &&
      delete_protection == o.delete_protection &&
      fixed_user_only == o.fixed_user_only &&
      json == o.json &&
      name == o.name &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      rdp_admin_name == o.rdp_admin_name &&
      rdp_admin_pwd == o.rdp_admin_pwd &&
      rdp_host_name == o.rdp_host_name &&
      rdp_host_port == o.rdp_host_port &&
      rdp_user_groups == o.rdp_user_groups &&
      secure_access_allow_external_user == o.secure_access_allow_external_user &&
      secure_access_enable == o.secure_access_enable &&
      secure_access_host == o.secure_access_host &&
      secure_access_rdp_domain == o.secure_access_rdp_domain &&
      secure_access_rdp_user == o.secure_access_rdp_user &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_ttl == o.user_ttl &&
      warn_user_before_expiration == o.warn_user_before_expiration
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
386
387
388
389
390
391
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 354

def _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_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



425
426
427
428
429
430
431
432
433
434
435
436
437
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 425

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 330

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


310
311
312
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 310

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



316
317
318
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 316

def hash
  [allow_user_extend_session, delete_protection, fixed_user_only, json, name, producer_encryption_key_name, rdp_admin_name, rdp_admin_pwd, rdp_host_name, rdp_host_port, rdp_user_groups, secure_access_allow_external_user, secure_access_enable, secure_access_host, secure_access_rdp_domain, secure_access_rdp_user, tags, target_name, token, uid_token, user_ttl, warn_user_before_expiration].hash
end

#list_invalid_propertiesObject

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



263
264
265
266
267
268
269
270
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 263

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



401
402
403
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 401

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/akeyless/models/gateway_create_producer_rdp.rb', line 407

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



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

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid



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

def valid?
  return false if @name.nil?
  true
end