Class: OCI::Desktops::Models::DesktopDevicePolicy

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

Overview

Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.

Constant Summary collapse

CLIPBOARD_MODE_ENUM = 
[
  CLIPBOARD_MODE_NONE = 'NONE'.freeze,
  CLIPBOARD_MODE_TODESKTOP = 'TODESKTOP'.freeze,
  CLIPBOARD_MODE_FROMDESKTOP = 'FROMDESKTOP'.freeze,
  CLIPBOARD_MODE_FULL = 'FULL'.freeze,
  CLIPBOARD_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUDIO_MODE_ENUM = 
[
  AUDIO_MODE_NONE = 'NONE'.freeze,
  AUDIO_MODE_TODESKTOP = 'TODESKTOP'.freeze,
  AUDIO_MODE_FROMDESKTOP = 'FROMDESKTOP'.freeze,
  AUDIO_MODE_FULL = 'FULL'.freeze,
  AUDIO_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CDM_MODE_ENUM = 
[
  CDM_MODE_NONE = 'NONE'.freeze,
  CDM_MODE_READONLY = 'READONLY'.freeze,
  CDM_MODE_FULL = 'FULL'.freeze,
  CDM_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DesktopDevicePolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :clipboard_mode (String) —

    The value to assign to the #clipboard_mode property

  • :audio_mode (String) —

    The value to assign to the #audio_mode property

  • :cdm_mode (String) —

    The value to assign to the #cdm_mode property

  • :is_printing_enabled (BOOLEAN) —

    The value to assign to the #is_printing_enabled property

  • :is_pointer_enabled (BOOLEAN) —

    The value to assign to the #is_pointer_enabled property

  • :is_keyboard_enabled (BOOLEAN) —

    The value to assign to the #is_keyboard_enabled property

  • :is_display_enabled (BOOLEAN) —

    The value to assign to the #is_display_enabled property

  • :is_video_input_enabled (BOOLEAN) —

    The value to assign to the #is_video_input_enabled property



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

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

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

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

  self.audio_mode = attributes[:'audioMode'] if attributes[:'audioMode']

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

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

  self.cdm_mode = attributes[:'cdmMode'] if attributes[:'cdmMode']

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

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

  self.is_printing_enabled = attributes[:'isPrintingEnabled'] unless attributes[:'isPrintingEnabled'].nil?

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

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

  self.is_pointer_enabled = attributes[:'isPointerEnabled'] unless attributes[:'isPointerEnabled'].nil?

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

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

  self.is_keyboard_enabled = attributes[:'isKeyboardEnabled'] unless attributes[:'isKeyboardEnabled'].nil?

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

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

  self.is_display_enabled = attributes[:'isDisplayEnabled'] unless attributes[:'isDisplayEnabled'].nil?

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

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

  self.is_video_input_enabled = attributes[:'isVideoInputEnabled'] unless attributes[:'isVideoInputEnabled'].nil?

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

  self.is_video_input_enabled = attributes[:'is_video_input_enabled'] unless attributes[:'is_video_input_enabled'].nil?
end

Instance Attribute Details

#audio_mode ⇒ String

[Required] The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 52

def audio_mode
  @audio_mode
end

#cdm_mode ⇒ String

[Required] The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.

Returns:

  • (String) 


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

def cdm_mode
  @cdm_mode
end

#clipboard_mode ⇒ String

[Required] The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.

Returns:

  • (String) 


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

def clipboard_mode
  @clipboard_mode
end

#is_display_enabled ⇒ BOOLEAN

[Required] Indicates whether the display is enabled.

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 76

def is_display_enabled
  @is_display_enabled
end

#is_keyboard_enabled ⇒ BOOLEAN

[Required] Indicates whether the keyboard is enabled.

Returns:

  • (BOOLEAN) 


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

def is_keyboard_enabled
  @is_keyboard_enabled
end

#is_pointer_enabled ⇒ BOOLEAN

[Required] Indicates whether the pointer is enabled.

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 68

def is_pointer_enabled
  @is_pointer_enabled
end

#is_printing_enabled ⇒ BOOLEAN

[Required] Indicates whether printing is enabled.

Returns:

  • (BOOLEAN) 


64
65
66
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 64

def is_printing_enabled
  @is_printing_enabled
end

#is_video_input_enabled ⇒ BOOLEAN

Indicates whether video input is enabled.

Returns:

  • (BOOLEAN) 


80
81
82
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 80

def is_video_input_enabled
  @is_video_input_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'clipboard_mode': :'clipboardMode',
    'audio_mode': :'audioMode',
    'cdm_mode': :'cdmMode',
    'is_printing_enabled': :'isPrintingEnabled',
    'is_pointer_enabled': :'isPointerEnabled',
    'is_keyboard_enabled': :'isKeyboardEnabled',
    'is_display_enabled': :'isDisplayEnabled',
    'is_video_input_enabled': :'isVideoInputEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'clipboard_mode': :'String',
    'audio_mode': :'String',
    'cdm_mode': :'String',
    'is_printing_enabled': :'BOOLEAN',
    'is_pointer_enabled': :'BOOLEAN',
    'is_keyboard_enabled': :'BOOLEAN',
    'is_display_enabled': :'BOOLEAN',
    'is_video_input_enabled': :'BOOLEAN'
    # 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



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 229

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

  self.class == other.class &&
    clipboard_mode == other.clipboard_mode &&
    audio_mode == other.audio_mode &&
    cdm_mode == other.cdm_mode &&
    is_printing_enabled == other.is_printing_enabled &&
    is_pointer_enabled == other.is_pointer_enabled &&
    is_keyboard_enabled == other.is_keyboard_enabled &&
    is_display_enabled == other.is_display_enabled &&
    is_video_input_enabled == other.is_video_input_enabled
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



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

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


246
247
248
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 255

def hash
  [clipboard_mode, audio_mode, cdm_mode, is_printing_enabled, is_pointer_enabled, is_keyboard_enabled, is_display_enabled, is_video_input_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 299

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



293
294
295
 
# File 'lib/oci/desktops/models/desktop_device_policy.rb', line 293

def to_s
  to_hash.to_s
end