@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class InstanceConsoleConnection extends Object
The InstanceConsoleConnection
API provides you with console access to Compute instances, enabling you to troubleshoot malfunctioning instances remotely.
For more information about console access, see Accessing the Console.
Note: Objects should always be created or deserialized using the InstanceConsoleConnection.Builder
. This model distinguishes fields that are null
because they are unset from fields that are explicitly set to null
. This is done in the setter methods of the InstanceConsoleConnection.Builder
, which maintain a set of all explicitly set fields called __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
InstanceConsoleConnection.Builder |
static class |
InstanceConsoleConnection.LifecycleState
The current state of the console connection.
|
Constructor and Description |
---|
InstanceConsoleConnection(String compartmentId,
String connectionString,
Map<String,Map<String,Object>> definedTags,
String fingerprint,
Map<String,String> freeformTags,
String id,
String instanceId,
InstanceConsoleConnection.LifecycleState lifecycleState,
String vncConnectionString)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static InstanceConsoleConnection.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment to contain the console connection.
|
String |
getConnectionString()
The SSH connection string for the console connection.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getFingerprint()
The SSH public key fingerprint for the console connection.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the console connection.
|
String |
getInstanceId()
The OCID of the instance the console connection connects to.
|
InstanceConsoleConnection.LifecycleState |
getLifecycleState()
The current state of the console connection.
|
String |
getVncConnectionString()
The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"compartmentId","connectionString","definedTags","fingerprint","freeformTags","id","instanceId","lifecycleState","vncConnectionString"}) @Deprecated public InstanceConsoleConnection(String compartmentId, String connectionString, Map<String,Map<String,Object>> definedTags, String fingerprint, Map<String,String> freeformTags, String id, String instanceId, InstanceConsoleConnection.LifecycleState lifecycleState, String vncConnectionString)
public static InstanceConsoleConnection.Builder builder()
Create a new builder.
public String getCompartmentId()
The OCID of the compartment to contain the console connection.
public String getConnectionString()
The SSH connection string for the console connection.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
public String getFingerprint()
The SSH public key fingerprint for the console connection.
public Map<String,String> getFreeformTags()
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\"}
public String getId()
The OCID of the console connection.
public String getInstanceId()
The OCID of the instance the console connection connects to.
public InstanceConsoleConnection.LifecycleState getLifecycleState()
The current state of the console connection.
public String getVncConnectionString()
The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
Copyright © 2016–2020. All rights reserved.