Class: OCI::Core::Models::InstanceConsoleConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/instance_console_connection.rb

Overview

The InstanceConsoleConnection API provides you with console access to Compute instances, enabling you to troubleshoot malfunctioning instances remotely.

For more information about instance console connections, see Troubleshooting Instances Using Instance Console Connections.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.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 = {}) ⇒ InstanceConsoleConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :connection_string (String) —

    The value to assign to the #connection_string property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :fingerprint (String) —

    The value to assign to the #fingerprint property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #id property

  • :instance_id (String) —

    The value to assign to the #instance_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :service_host_key_fingerprint (String) —

    The value to assign to the #service_host_key_fingerprint property

  • :vnc_connection_string (String) —

    The value to assign to the #vnc_connection_string property



127
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
182
183
184
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 127

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

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

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

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

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

  self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId']

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

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

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

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

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

  self.vnc_connection_string = attributes[:'vncConnectionString'] if attributes[:'vncConnectionString']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment to contain the console connection.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 27

def compartment_id
  @compartment_id
end

#connection_string ⇒ String

The SSH connection string for the console connection.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 31

def connection_string
  @connection_string
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>>) 


39
40
41
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 39

def defined_tags
  @defined_tags
end

#fingerprint ⇒ String

The SSH public key's fingerprint for client authentication to the console connection.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 43

def fingerprint
  @fingerprint
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>) 


51
52
53
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 51

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the console connection.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 55

def id
  @id
end

#instance_id ⇒ String

The OCID of the instance the console connection connects to.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 59

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

The current state of the console connection.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 63

def lifecycle_state
  @lifecycle_state
end

#service_host_key_fingerprint ⇒ String

The SSH public key's fingerprint for the console connection service host.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 67

def service_host_key_fingerprint
  @service_host_key_fingerprint
end

#vnc_connection_string ⇒ String

The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 73

def vnc_connection_string
  @vnc_connection_string
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'connection_string': :'connectionString',
    'defined_tags': :'definedTags',
    'fingerprint': :'fingerprint',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'instance_id': :'instanceId',
    'lifecycle_state': :'lifecycleState',
    'service_host_key_fingerprint': :'serviceHostKeyFingerprint',
    'vnc_connection_string': :'vncConnectionString'
    # 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
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 94

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'connection_string': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'fingerprint': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'instance_id': :'String',
    'lifecycle_state': :'String',
    'service_host_key_fingerprint': :'String',
    'vnc_connection_string': :'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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 206

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    connection_string == other.connection_string &&
    defined_tags == other.defined_tags &&
    fingerprint == other.fingerprint &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    instance_id == other.instance_id &&
    lifecycle_state == other.lifecycle_state &&
    service_host_key_fingerprint == other.service_host_key_fingerprint &&
    vnc_connection_string == other.vnc_connection_string
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 245

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


225
226
227
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 234

def hash
  [compartment_id, connection_string, defined_tags, fingerprint, freeform_tags, id, instance_id, lifecycle_state, service_host_key_fingerprint, vnc_connection_string].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 278

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



272
273
274
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 272

def to_s
  to_hash.to_s
end