Class: OCI::Desktops::Models::DesktopPool

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/desktops/models/desktop_pool.rb

Overview

Provides information about a desktop pool including all configuration parameters.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DesktopPool

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 222

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.maximum_size = attributes[:'maximumSize'] if attributes[:'maximumSize']

  raise 'You cannot provide both :maximumSize and :maximum_size' if attributes.key?(:'maximumSize') && attributes.key?(:'maximum_size')

  self.maximum_size = attributes[:'maximum_size'] if attributes[:'maximum_size']

  self.standby_size = attributes[:'standbySize'] if attributes[:'standbySize']

  raise 'You cannot provide both :standbySize and :standby_size' if attributes.key?(:'standbySize') && attributes.key?(:'standby_size')

  self.standby_size = attributes[:'standby_size'] if attributes[:'standby_size']

  self.shape_name = attributes[:'shapeName'] if attributes[:'shapeName']

  raise 'You cannot provide both :shapeName and :shape_name' if attributes.key?(:'shapeName') && attributes.key?(:'shape_name')

  self.shape_name = attributes[:'shape_name'] if attributes[:'shape_name']

  self.is_storage_enabled = attributes[:'isStorageEnabled'] unless attributes[:'isStorageEnabled'].nil?

  raise 'You cannot provide both :isStorageEnabled and :is_storage_enabled' if attributes.key?(:'isStorageEnabled') && attributes.key?(:'is_storage_enabled')

  self.is_storage_enabled = attributes[:'is_storage_enabled'] unless attributes[:'is_storage_enabled'].nil?

  self.storage_size_in_gbs = attributes[:'storageSizeInGBs'] if attributes[:'storageSizeInGBs']

  raise 'You cannot provide both :storageSizeInGBs and :storage_size_in_gbs' if attributes.key?(:'storageSizeInGBs') && attributes.key?(:'storage_size_in_gbs')

  self.storage_size_in_gbs = attributes[:'storage_size_in_gbs'] if attributes[:'storage_size_in_gbs']

  self.storage_backup_policy_id = attributes[:'storageBackupPolicyId'] if attributes[:'storageBackupPolicyId']

  raise 'You cannot provide both :storageBackupPolicyId and :storage_backup_policy_id' if attributes.key?(:'storageBackupPolicyId') && attributes.key?(:'storage_backup_policy_id')

  self.storage_backup_policy_id = attributes[:'storage_backup_policy_id'] if attributes[:'storage_backup_policy_id']

  self.device_policy = attributes[:'devicePolicy'] if attributes[:'devicePolicy']

  raise 'You cannot provide both :devicePolicy and :device_policy' if attributes.key?(:'devicePolicy') && attributes.key?(:'device_policy')

  self.device_policy = attributes[:'device_policy'] if attributes[:'device_policy']

  self.availability_policy = attributes[:'availabilityPolicy'] if attributes[:'availabilityPolicy']

  raise 'You cannot provide both :availabilityPolicy and :availability_policy' if attributes.key?(:'availabilityPolicy') && attributes.key?(:'availability_policy')

  self.availability_policy = attributes[:'availability_policy'] if attributes[:'availability_policy']

  self.image = attributes[:'image'] if attributes[:'image']

  self.network_configuration = attributes[:'networkConfiguration'] if attributes[:'networkConfiguration']

  raise 'You cannot provide both :networkConfiguration and :network_configuration' if attributes.key?(:'networkConfiguration') && attributes.key?(:'network_configuration')

  self.network_configuration = attributes[:'network_configuration'] if attributes[:'network_configuration']

  self.time_start_scheduled = attributes[:'timeStartScheduled'] if attributes[:'timeStartScheduled']

  raise 'You cannot provide both :timeStartScheduled and :time_start_scheduled' if attributes.key?(:'timeStartScheduled') && attributes.key?(:'time_start_scheduled')

  self.time_start_scheduled = attributes[:'time_start_scheduled'] if attributes[:'time_start_scheduled']

  self.time_stop_scheduled = attributes[:'timeStopScheduled'] if attributes[:'timeStopScheduled']

  raise 'You cannot provide both :timeStopScheduled and :time_stop_scheduled' if attributes.key?(:'timeStopScheduled') && attributes.key?(:'time_stop_scheduled')

  self.time_stop_scheduled = attributes[:'time_stop_scheduled'] if attributes[:'time_stop_scheduled']

  self.contact_details = attributes[:'contactDetails'] if attributes[:'contactDetails']

  raise 'You cannot provide both :contactDetails and :contact_details' if attributes.key?(:'contactDetails') && attributes.key?(:'contact_details')

  self.contact_details = attributes[:'contact_details'] if attributes[:'contact_details']

  self.are_privileged_users = attributes[:'arePrivilegedUsers'] unless attributes[:'arePrivilegedUsers'].nil?

  raise 'You cannot provide both :arePrivilegedUsers and :are_privileged_users' if attributes.key?(:'arePrivilegedUsers') && attributes.key?(:'are_privileged_users')

  self.are_privileged_users = attributes[:'are_privileged_users'] unless attributes[:'are_privileged_users'].nil?

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

  raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain')

  self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

  raise 'You cannot provide both :nsgIds and :nsg_ids' if attributes.key?(:'nsgIds') && attributes.key?(:'nsg_ids')

  self.nsg_ids = attributes[:'nsg_ids'] if attributes[:'nsg_ids']
end

Instance Attribute Details

#are_privileged_users ⇒ BOOLEAN

[Required] Indicates whether desktop pool users have administrative privileges on their desktop.

Returns:

  • (BOOLEAN) 


105
106
107
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 105

def are_privileged_users
  @are_privileged_users
end

#availability_domain ⇒ String

[Required] The availability domain of the desktop pool.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 109

def availability_domain
  @availability_domain
end

#availability_policy ⇒ OCI::Desktops::Models::DesktopAvailabilityPolicy

This attribute is required.

Returns:



79
80
81
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 79

def availability_policy
  @availability_policy
end

#compartment_id ⇒ String

[Required] The OCID of the compartment of the desktop pool.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 29

def compartment_id
  @compartment_id
end

#contact_details ⇒ String

[Required] Contact information of the desktop pool administrator. Avoid entering confidential information.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 101

def contact_details
  @contact_details
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


122
123
124
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 122

def defined_tags
  @defined_tags
end

#description ⇒ String

A user friendly description providing additional information about the resource. Avoid entering confidential information.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 39

def description
  @description
end

#device_policy ⇒ OCI::Desktops::Models::DesktopDevicePolicy

This attribute is required.

Returns:



75
76
77
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 75

def device_policy
  @device_policy
end

#display_name ⇒ String

[Required] A user friendly display name. Avoid entering confidential information.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 33

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


115
116
117
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 115

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the desktop pool.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 25

def id
  @id
end

#image ⇒ OCI::Desktops::Models::DesktopImage

This attribute is required.

Returns:



83
84
85
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 83

def image
  @image
end

#is_storage_enabled ⇒ BOOLEAN

[Required] Indicates whether storage is enabled for the desktop pool.

Returns:

  • (BOOLEAN) 


63
64
65
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 63

def is_storage_enabled
  @is_storage_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the desktop pool.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#maximum_size ⇒ Integer

[Required] The maximum number of desktops permitted in the desktop pool.

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 51

def maximum_size
  @maximum_size
end

#network_configuration ⇒ OCI::Desktops::Models::DesktopNetworkConfiguration

This attribute is required.

Returns:



87
88
89
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 87

def network_configuration
  @network_configuration
end

#nsg_ids ⇒ Array<String>

A list of network security groups for the desktop pool.

Returns:

  • (Array<String>) 


126
127
128
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 126

def nsg_ids
  @nsg_ids
end

#shape_name ⇒ String

[Required] The shape of the desktop pool.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 59

def shape_name
  @shape_name
end

#standby_size ⇒ Integer

[Required] The maximum number of standby desktops available in the desktop pool.

Returns:

  • (Integer) 


55
56
57
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 55

def standby_size
  @standby_size
end

#storage_backup_policy_id ⇒ String

[Required] The backup policy OCID of the storage.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 71

def storage_backup_policy_id
  @storage_backup_policy_id
end

#storage_size_in_gbs ⇒ Integer

[Required] The size in GBs of the storage for the desktop pool.

Returns:

  • (Integer) 


67
68
69
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 67

def storage_size_in_gbs
  @storage_size_in_gbs
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created.

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 47

def time_created
  @time_created
end

#time_start_scheduled ⇒ DateTime

The start time of the desktop pool.

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 91

def time_start_scheduled
  @time_start_scheduled
end

#time_stop_scheduled ⇒ DateTime

The stop time of the desktop pool.

Returns:

  • (DateTime) 


95
96
97
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 95

def time_stop_scheduled
  @time_stop_scheduled
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 129

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'maximum_size': :'maximumSize',
    'standby_size': :'standbySize',
    'shape_name': :'shapeName',
    'is_storage_enabled': :'isStorageEnabled',
    'storage_size_in_gbs': :'storageSizeInGBs',
    'storage_backup_policy_id': :'storageBackupPolicyId',
    'device_policy': :'devicePolicy',
    'availability_policy': :'availabilityPolicy',
    'image': :'image',
    'network_configuration': :'networkConfiguration',
    'time_start_scheduled': :'timeStartScheduled',
    'time_stop_scheduled': :'timeStopScheduled',
    'contact_details': :'contactDetails',
    'are_privileged_users': :'arePrivilegedUsers',
    'availability_domain': :'availabilityDomain',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'nsg_ids': :'nsgIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'maximum_size': :'Integer',
    'standby_size': :'Integer',
    'shape_name': :'String',
    'is_storage_enabled': :'BOOLEAN',
    'storage_size_in_gbs': :'Integer',
    'storage_backup_policy_id': :'String',
    'device_policy': :'OCI::Desktops::Models::DesktopDevicePolicy',
    'availability_policy': :'OCI::Desktops::Models::DesktopAvailabilityPolicy',
    'image': :'OCI::Desktops::Models::DesktopImage',
    'network_configuration': :'OCI::Desktops::Models::DesktopNetworkConfiguration',
    'time_start_scheduled': :'DateTime',
    'time_stop_scheduled': :'DateTime',
    'contact_details': :'String',
    'are_privileged_users': :'BOOLEAN',
    'availability_domain': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'nsg_ids': :'Array<String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 381

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    maximum_size == other.maximum_size &&
    standby_size == other.standby_size &&
    shape_name == other.shape_name &&
    is_storage_enabled == other.is_storage_enabled &&
    storage_size_in_gbs == other.storage_size_in_gbs &&
    storage_backup_policy_id == other.storage_backup_policy_id &&
    device_policy == other.device_policy &&
    availability_policy == other.availability_policy &&
    image == other.image &&
    network_configuration == other.network_configuration &&
    time_start_scheduled == other.time_start_scheduled &&
    time_stop_scheduled == other.time_stop_scheduled &&
    contact_details == other.contact_details &&
    are_privileged_users == other.are_privileged_users &&
    availability_domain == other.availability_domain &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    nsg_ids == other.nsg_ids
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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 434

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


414
415
416
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 414

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



423
424
425
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 423

def hash
  [id, compartment_id, display_name, description, lifecycle_state, time_created, maximum_size, standby_size, shape_name, is_storage_enabled, storage_size_in_gbs, storage_backup_policy_id, device_policy, availability_policy, image, network_configuration, time_start_scheduled, time_stop_scheduled, contact_details, are_privileged_users, availability_domain, freeform_tags, defined_tags, nsg_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



467
468
469
470
471
472
473
474
475
476
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 467

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



461
462
463
 
# File 'lib/oci/desktops/models/desktop_pool.rb', line 461

def to_s
  to_hash.to_s
end