Package com.oracle.bmc.bastion.model

Class Session

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.bastion.model.Session

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210331")
public final class Session
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A bastion session resource.

A bastion session lets authorized users connect to a target resource using a Secure Shell (SSH) for a predetermined amount of time.
Note: Objects should always be created or deserialized using the Session.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 Session.Builder, which maintain a set of all explicitly set fields called Session.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Session.Builder
static class	Session.KeyType	The type of the key used to connect to the session.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Session(String id, String displayName, String bastionId, String bastionName, String bastionUserName, TargetResourceDetails targetResourceDetails, Map<String,String> sshMetadata, Session.KeyType keyType, PublicKeyDetails keyDetails, String bastionPublicHostKeyInfo, Date timeCreated, Date timeUpdated, SessionLifecycleState lifecycleState, String lifecycleDetails, Integer sessionTtlInSeconds)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Session.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBastionId()	The unique identifier (OCID) of the bastion that is hosting this session.
String	getBastionName()	The name of the bastion that is hosting this session.
String	getBastionPublicHostKeyInfo()	The public key of the bastion host.
String	getBastionUserName()	The username that the session uses to connect to the target resource.
String	getDisplayName()	The name of the session.
String	getId()	The unique identifier (OCID) of the session, which can’t be changed after creation.
PublicKeyDetails	getKeyDetails()
Session.KeyType	getKeyType()	The type of the key used to connect to the session.
String	getLifecycleDetails()	A message describing the current session state in more detail.
SessionLifecycleState	getLifecycleState()	The current state of the session.
Integer	getSessionTtlInSeconds()	The amount of time the session can remain active.
Map<String,String>	getSshMetadata()	The connection message for the session.
TargetResourceDetails	getTargetResourceDetails()
Date	getTimeCreated()	The time the session was created.
Date	getTimeUpdated()	The time the session was updated.
int	hashCode()
Session.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Session

@Deprecated
@ConstructorProperties({"id","displayName","bastionId","bastionName","bastionUserName","targetResourceDetails","sshMetadata","keyType","keyDetails","bastionPublicHostKeyInfo","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","sessionTtlInSeconds"})
public Session(String id,
               String displayName,
               String bastionId,
               String bastionName,
               String bastionUserName,
               TargetResourceDetails targetResourceDetails,
               Map<String,String> sshMetadata,
               Session.KeyType keyType,
               PublicKeyDetails keyDetails,
               String bastionPublicHostKeyInfo,
               Date timeCreated,
               Date timeUpdated,
               SessionLifecycleState lifecycleState,
               String lifecycleDetails,
               Integer sessionTtlInSeconds)

Deprecated.

Method Detail

builder

public static Session.Builder builder()

Create a new builder.

toBuilder

public Session.Builder toBuilder()

getId

public String getId()

The unique identifier (OCID) of the session, which can’t be changed after creation.

Returns:

the value

getDisplayName

public String getDisplayName()

The name of the session.

Returns:

the value

getBastionId

public String getBastionId()

The unique identifier (OCID) of the bastion that is hosting this session.

Returns:

the value

getBastionName

public String getBastionName()

The name of the bastion that is hosting this session.

Returns:

the value

getBastionUserName

public String getBastionUserName()

The username that the session uses to connect to the target resource.

Returns:

the value

getTargetResourceDetails

public TargetResourceDetails getTargetResourceDetails()

getSshMetadata

public Map<String,String> getSshMetadata()

The connection message for the session.

Returns:

the value

getKeyType

public Session.KeyType getKeyType()

The type of the key used to connect to the session.

PUB is a standard public key in OpenSSH format.

Returns:

the value

getKeyDetails

public PublicKeyDetails getKeyDetails()

getBastionPublicHostKeyInfo

public String getBastionPublicHostKeyInfo()

The public key of the bastion host.

You can use this to verify that you’re connecting to the correct bastion.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the session was created.

Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time the session was updated.

Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

the value

getLifecycleState

public SessionLifecycleState getLifecycleState()

The current state of the session.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current session state in more detail.

Returns:

the value

getSessionTtlInSeconds

public Integer getSessionTtlInSeconds()

The amount of time the session can remain active.

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