Class: OCI::Desktops::Models::UpdateDesktopPoolDetails

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

Overview

Provides the details of a request to update the desktop pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDesktopPoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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/oci/desktops/models/update_desktop_pool_details.rb', line 160

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.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.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.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.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.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.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.session_lifecycle_actions = attributes[:'sessionLifecycleActions'] if attributes[:'sessionLifecycleActions']

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

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

  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.private_access_details = attributes[:'privateAccessDetails'] if attributes[:'privateAccessDetails']

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

  self.boot_volume_size_in_gbs = attributes[:'bootVolumeSizeInGBs'] if attributes[:'bootVolumeSizeInGBs']

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

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

Instance Attribute Details

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

Returns:



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

def availability_policy
  @availability_policy
end

#boot_volume_size_in_gbs ⇒ Integer

The size in GBs of the boot volume for the desktop pool.

Returns:

  • (Integer) 


85
86
87
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 85

def boot_volume_size_in_gbs
  @boot_volume_size_in_gbs
end

#contact_details ⇒ String

Contact information of the desktop pool administrator. Avoid entering confidential information.

Returns:

  • (String) 


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

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>>) 


60
61
62
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 60

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 19

def description
  @description
end

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

Returns:



30
31
32
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 30

def device_policy
  @device_policy
end

#display_name ⇒ String

A user friendly display name. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 13

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>) 


53
54
55
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 53

def freeform_tags
  @freeform_tags
end

#image ⇒ OCI::Desktops::Models::UpdateDesktopImage

Returns:



66
67
68
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 66

def image
  @image
end

#maximum_size ⇒ Integer

The maximum number of desktops permitted in the desktop pool.

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 23

def maximum_size
  @maximum_size
end

#network_configuration ⇒ OCI::Desktops::Models::UpdateDesktopNetworkConfiguration

Returns:



69
70
71
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 69

def network_configuration
  @network_configuration
end

#private_access_details ⇒ OCI::Desktops::Models::UpdateDesktopPoolPrivateAccessDetails

Returns:



72
73
74
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 72

def private_access_details
  @private_access_details
end

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

Security attributes for this resource. Each attribute can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


81
82
83
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 81

def security_attributes
  @security_attributes
end

#session_lifecycle_actions ⇒ OCI::Desktops::Models::UpdateDesktopPoolDesktopSessionLifecycleActions

Returns:



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

def session_lifecycle_actions
  @session_lifecycle_actions
end

#standby_size ⇒ Integer

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

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 27

def standby_size
  @standby_size
end

#time_start_scheduled ⇒ DateTime

The start time of the desktop pool.

Returns:

  • (DateTime) 


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

def time_start_scheduled
  @time_start_scheduled
end

#time_stop_scheduled ⇒ DateTime

The stop time of the desktop pool.

Returns:

  • (DateTime) 


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

def time_stop_scheduled
  @time_stop_scheduled
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'maximum_size': :'maximumSize',
    'standby_size': :'standbySize',
    'device_policy': :'devicePolicy',
    'availability_policy': :'availabilityPolicy',
    'contact_details': :'contactDetails',
    'time_start_scheduled': :'timeStartScheduled',
    'time_stop_scheduled': :'timeStopScheduled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'session_lifecycle_actions': :'sessionLifecycleActions',
    'image': :'image',
    'network_configuration': :'networkConfiguration',
    'private_access_details': :'privateAccessDetails',
    'security_attributes': :'securityAttributes',
    'boot_volume_size_in_gbs': :'bootVolumeSizeInGBs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'maximum_size': :'Integer',
    'standby_size': :'Integer',
    'device_policy': :'OCI::Desktops::Models::DesktopDevicePolicy',
    'availability_policy': :'OCI::Desktops::Models::DesktopAvailabilityPolicy',
    'contact_details': :'String',
    'time_start_scheduled': :'DateTime',
    'time_stop_scheduled': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'session_lifecycle_actions': :'OCI::Desktops::Models::UpdateDesktopPoolDesktopSessionLifecycleActions',
    'image': :'OCI::Desktops::Models::UpdateDesktopImage',
    'network_configuration': :'OCI::Desktops::Models::UpdateDesktopNetworkConfiguration',
    'private_access_details': :'OCI::Desktops::Models::UpdateDesktopPoolPrivateAccessDetails',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'boot_volume_size_in_gbs': :'Integer'
    # 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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 268

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    maximum_size == other.maximum_size &&
    standby_size == other.standby_size &&
    device_policy == other.device_policy &&
    availability_policy == other.availability_policy &&
    contact_details == other.contact_details &&
    time_start_scheduled == other.time_start_scheduled &&
    time_stop_scheduled == other.time_stop_scheduled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    session_lifecycle_actions == other.session_lifecycle_actions &&
    image == other.image &&
    network_configuration == other.network_configuration &&
    private_access_details == other.private_access_details &&
    security_attributes == other.security_attributes &&
    boot_volume_size_in_gbs == other.boot_volume_size_in_gbs
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 314

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


294
295
296
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 294

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 303

def hash
  [display_name, description, maximum_size, standby_size, device_policy, availability_policy, contact_details, time_start_scheduled, time_stop_scheduled, freeform_tags, defined_tags, session_lifecycle_actions, image, network_configuration, private_access_details, security_attributes, boot_volume_size_in_gbs].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 347

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



341
342
343
 
# File 'lib/oci/desktops/models/update_desktop_pool_details.rb', line 341

def to_s
  to_hash.to_s
end