com.oracle.bmc.bastion.model

Class CreateSessionDetails

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.bastion.model.CreateSessionDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210331")
public final class CreateSessionDetails
extends ExplicitlySetBmcModel

The configuration details for a new bastion session. A session lets authorized users connect to a target resource for a predetermined amount of time. The Bastion service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.
Note: Objects should always be created or deserialized using the CreateSessionDetails.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 CreateSessionDetails.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateSessionDetails(String displayName, String bastionId, CreateSessionTargetResourceDetails targetResourceDetails, CreateSessionDetails.KeyType keyType, PublicKeyDetails keyDetails, Integer sessionTtlInSeconds) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateSessionDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getBastionId() The unique identifier (OCID) of the bastion on which to create this session.
String	getDisplayName() The name of the session.
PublicKeyDetails	getKeyDetails()
CreateSessionDetails.KeyType	getKeyType() The type of the key used to connect to the session.
Integer	getSessionTtlInSeconds() The amount of time the session can remain active.
CreateSessionTargetResourceDetails	getTargetResourceDetails()
int	hashCode()
CreateSessionDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSessionDetails

@Deprecated
 @ConstructorProperties(value={"displayName","bastionId","targetResourceDetails","keyType","keyDetails","sessionTtlInSeconds"})
public CreateSessionDetails(String displayName,
                                                                                                                                                                        String bastionId,
                                                                                                                                                                        CreateSessionTargetResourceDetails targetResourceDetails,
                                                                                                                                                                        CreateSessionDetails.KeyType keyType,
                                                                                                                                                                        PublicKeyDetails keyDetails,
                                                                                                                                                                        Integer sessionTtlInSeconds)

Deprecated.

Method Detail

builder

public static CreateSessionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateSessionDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

The name of the session.

Returns:

the value

getBastionId

public String getBastionId()

The unique identifier (OCID) of the bastion on which to create this session.

Returns:

the value

getTargetResourceDetails

public CreateSessionTargetResourceDetails getTargetResourceDetails()

getKeyType

public CreateSessionDetails.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()

getSessionTtlInSeconds

public Integer getSessionTtlInSeconds()

The amount of time the session can remain active.

Returns:

the value

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel