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 virtual machine (VM) instances, enabling you to troubleshoot malfunctioning instances remotely.

For more information about console access, see [Accessing the Console](docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute 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

  • :vnc_connection_string (String) —

    The value to assign to the #vnc_connection_string property



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 80

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}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment to contain the console connection.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 23

def compartment_id
  @compartment_id
end

#connection_string ⇒ String

The SSH connection string for the console connection.

Returns:

  • (String) 


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

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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

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


35
36
37
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 35

def defined_tags
  @defined_tags
end

#fingerprint ⇒ String

The SSH public key fingerprint for the console connection.

Returns:

  • (String) 


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

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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


48
49
50
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 48

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the console connection.

Returns:

  • (String) 


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

def id
  @id
end

#instance_id ⇒ String

The OCID of the instance the console connection connects to.

Returns:

  • (String) 


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

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

The current state of the console connection.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#vnc_connection_string ⇒ String

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

Returns:

  • (String) 


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

def vnc_connection_string
  @vnc_connection_string
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 178

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      connection_string == other_object.connection_string &&
      defined_tags == other_object.defined_tags &&
      fingerprint == other_object.fingerprint &&
      freeform_tags == other_object.freeform_tags &&
      id == other_object.id &&
      instance_id == other_object.instance_id &&
      lifecycle_state == other_object.lifecycle_state &&
      vnc_connection_string == other_object.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



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

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 194

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 200

def hash
  [compartment_id, connection_string, defined_tags, fingerprint, freeform_tags, id, instance_id, lifecycle_state, 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



232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/core/models/instance_console_connection.rb', line 232

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



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

def to_s
  to_hash.to_s
end