Class: OCI::CloudMigrations::Models::OlvmDisplay

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_migrations/models/olvm_display.rb

Overview

Display object in OLVM

Constant Summary collapse

DISPLAY_TYPE_ENUM = 
[
  DISPLAY_TYPE_SPICE = 'SPICE'.freeze,
  DISPLAY_TYPE_VNC = 'VNC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OlvmDisplay

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
201
202
203
204
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 135

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

  self.is_allow_override = attributes[:'isAllowOverride'] unless attributes[:'isAllowOverride'].nil?

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

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

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

  self.is_copy_paste_enabled = attributes[:'isCopyPasteEnabled'] unless attributes[:'isCopyPasteEnabled'].nil?

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

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

  self.disconnect_action = attributes[:'disconnectAction'] if attributes[:'disconnectAction']

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

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

  self.disconnect_action_delay_in_minutes = attributes[:'disconnectActionDelayInMinutes'] if attributes[:'disconnectActionDelayInMinutes']

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

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

  self.is_file_transfer_enabled = attributes[:'isFileTransferEnabled'] unless attributes[:'isFileTransferEnabled'].nil?

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

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

  self.keyboard_layout = attributes[:'keyboardLayout'] if attributes[:'keyboardLayout']

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

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

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

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

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

  self.secure_port = attributes[:'securePort'] if attributes[:'securePort']

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

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

  self.is_single_qxl_pci = attributes[:'isSingleQxlPci'] unless attributes[:'isSingleQxlPci'].nil?

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

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

  self.display_type = attributes[:'displayType'] if attributes[:'displayType']

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

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

Instance Attribute Details

#address ⇒ String

The IP address of the guest to connect the graphic console client to.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 18

def address
  @address
end

#certificate ⇒ OCI::CloudMigrations::Models::OlvmCertificate

Returns:



25
26
27
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 25

def certificate
  @certificate
end

#disconnect_action ⇒ String

Returns the action that will take place when the graphic console is disconnected.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 33

def disconnect_action
  @disconnect_action
end

#disconnect_action_delay_in_minutes ⇒ Integer

Delay (in minutes) before the graphic console disconnect action is carried out.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 37

def disconnect_action_delay_in_minutes
  @disconnect_action_delay_in_minutes
end

#display_type ⇒ String

The graphic console protocol type.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 69

def display_type
  @display_type
end

#is_allow_override ⇒ BOOLEAN

Indicates if to override the display address per host.

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 22

def is_allow_override
  @is_allow_override
end

#is_copy_paste_enabled ⇒ BOOLEAN

Indicates whether a user is able to copy and paste content from an external host into the graphic console.

Returns:

  • (BOOLEAN) 


29
30
31
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 29

def is_copy_paste_enabled
  @is_copy_paste_enabled
end

#is_file_transfer_enabled ⇒ BOOLEAN

Indicates if a user is able to drag and drop files from an external host into the graphic console.

Returns:

  • (BOOLEAN) 


41
42
43
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 41

def is_file_transfer_enabled
  @is_file_transfer_enabled
end

#is_single_qxl_pci ⇒ BOOLEAN

The engine now sets it automatically according to the operating system.

Returns:

  • (BOOLEAN) 


65
66
67
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 65

def is_single_qxl_pci
  @is_single_qxl_pci
end

#keyboard_layout ⇒ String

The keyboard layout to use with this graphic console.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 45

def keyboard_layout
  @keyboard_layout
end

#monitors ⇒ Integer

The number of monitors opened for this graphic console.

Returns:

  • (Integer) 


49
50
51
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 49

def monitors
  @monitors
end

#port ⇒ Integer

The port address on the guest to connect the graphic console client to

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 53

def port
  @port
end

#proxy ⇒ String

The proxy IP which will be used by the graphic console client to connect to the guest.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 57

def proxy
  @proxy
end

#secure_port ⇒ Integer

The secured port address on the guest, in case of using TLS, to connect the graphic console client to.

Returns:

  • (Integer) 


61
62
63
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 61

def secure_port
  @secure_port
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'address': :'address',
    'is_allow_override': :'isAllowOverride',
    'certificate': :'certificate',
    'is_copy_paste_enabled': :'isCopyPasteEnabled',
    'disconnect_action': :'disconnectAction',
    'disconnect_action_delay_in_minutes': :'disconnectActionDelayInMinutes',
    'is_file_transfer_enabled': :'isFileTransferEnabled',
    'keyboard_layout': :'keyboardLayout',
    'monitors': :'monitors',
    'port': :'port',
    'proxy': :'proxy',
    'secure_port': :'securePort',
    'is_single_qxl_pci': :'isSingleQxlPci',
    'display_type': :'displayType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 94

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'address': :'String',
    'is_allow_override': :'BOOLEAN',
    'certificate': :'OCI::CloudMigrations::Models::OlvmCertificate',
    'is_copy_paste_enabled': :'BOOLEAN',
    'disconnect_action': :'String',
    'disconnect_action_delay_in_minutes': :'Integer',
    'is_file_transfer_enabled': :'BOOLEAN',
    'keyboard_layout': :'String',
    'monitors': :'Integer',
    'port': :'Integer',
    'proxy': :'String',
    'secure_port': :'Integer',
    'is_single_qxl_pci': :'BOOLEAN',
    'display_type': :'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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 221

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

  self.class == other.class &&
    address == other.address &&
    is_allow_override == other.is_allow_override &&
    certificate == other.certificate &&
    is_copy_paste_enabled == other.is_copy_paste_enabled &&
    disconnect_action == other.disconnect_action &&
    disconnect_action_delay_in_minutes == other.disconnect_action_delay_in_minutes &&
    is_file_transfer_enabled == other.is_file_transfer_enabled &&
    keyboard_layout == other.keyboard_layout &&
    monitors == other.monitors &&
    port == other.port &&
    proxy == other.proxy &&
    secure_port == other.secure_port &&
    is_single_qxl_pci == other.is_single_qxl_pci &&
    display_type == other.display_type
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



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

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


244
245
246
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 244

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 253

def hash
  [address, is_allow_override, certificate, is_copy_paste_enabled, disconnect_action, disconnect_action_delay_in_minutes, is_file_transfer_enabled, keyboard_layout, monitors, port, proxy, secure_port, is_single_qxl_pci, display_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 297

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



291
292
293
 
# File 'lib/oci/cloud_migrations/models/olvm_display.rb', line 291

def to_s
  to_hash.to_s
end