software.amazon.awssdk.services.athena.model

Class StartSessionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.athena.model.AthenaRequest

software.amazon.awssdk.services.athena.model.StartSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartSessionRequest
extends AthenaRequest
implements ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartSessionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartSessionRequest.Builder	builder()
String	clientRequestToken() A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once).
String	description() The session description.
EngineConfiguration	engineConfiguration() Contains engine data processing unit (DPU) configuration settings and parameter mappings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	notebookVersion() The notebook version.
List<SdkField<?>>	sdkFields()
static Class<? extends StartSessionRequest.Builder>	serializableBuilderClass()
Integer	sessionIdleTimeoutInMinutes() The idle timeout in minutes for the session.
StartSessionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workGroup() The workgroup to which the session belongs.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public final String description()

The session description.

Returns:

The session description.

workGroup

public final String workGroup()

The workgroup to which the session belongs.

Returns:

The workgroup to which the session belongs.

engineConfiguration

public final EngineConfiguration engineConfiguration()

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

Returns:

Contains engine data processing unit (DPU) configuration settings and parameter mappings.

notebookVersion

public final String notebookVersion()

The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is Athena notebook version 1. If you specify a value for NotebookVersion, you must also specify a value for NotebookId. See EngineConfiguration$AdditionalConfigs.

Returns:

The notebook version. This value is supplied automatically for notebook sessions in the Athena console and is not required for programmatic session access. The only valid notebook version is Athena notebook version 1. If you specify a value for NotebookVersion, you must also specify a value for NotebookId. See EngineConfiguration$AdditionalConfigs.

sessionIdleTimeoutInMinutes

public final Integer sessionIdleTimeoutInMinutes()

The idle timeout in minutes for the session.

Returns:

The idle timeout in minutes for the session.

clientRequestToken

public final String clientRequestToken()

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Returns:

A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

toBuilder

public StartSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static StartSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartSessionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo