Package com.oracle.bmc.core.model

Class InstanceConsoleConnection

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class InstanceConsoleConnection
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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](https://docs.oracle.com/iaas/Content/Compute/References/serialconsole.htm).
    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 InstanceConsoleConnection.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to contain the console connection.
        Returns:
        the value

      • getConnectionString

        public String getConnectionString()
        The SSH connection string for the console connection.
        Returns:
        the value

      • getDefinedTags

        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"}}

        Returns:
        the value

      • getFingerprint

        public String getFingerprint()
        The SSH public key’s fingerprint for client authentication to the console connection.
        Returns:
        the value

      • getFreeformTags

        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"}

        Returns:
        the value

      • getId

        public String getId()
        The OCID of the console connection.
        Returns:
        the value

      • getInstanceId

        public String getInstanceId()
        The OCID of the instance the console connection connects to.
        Returns:
        the value

      • getServiceHostKeyFingerprint

        public String getServiceHostKeyFingerprint()
        The SSH public key’s fingerprint for the console connection service host.
        Returns:
        the value

      • getVncConnectionString

        public String getVncConnectionString()
        The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel