Package software.amazon.awssdk.services.athena.model

Interface StartSessionRequest.Builder

All Superinterfaces:
AthenaRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>, SdkBuilder<StartSessionRequest.Builder,StartSessionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartSessionRequest
public static interface StartSessionRequest.Builder extends AthenaRequest.Builder, SdkPojo, CopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

  • Method Details

    • description

      StartSessionRequest.Builder description(String description)

      The session description.

      Parameters:
      description - The session description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workGroup

      StartSessionRequest.Builder workGroup(String workGroup)

      The workgroup to which the session belongs.

      Parameters:
      workGroup - The workgroup to which the session belongs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfiguration

      StartSessionRequest.Builder engineConfiguration(EngineConfiguration engineConfiguration)

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

      Parameters:
      engineConfiguration - Contains engine data processing unit (DPU) configuration settings and parameter mappings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfiguration

      default StartSessionRequest.Builder engineConfiguration(Consumer<EngineConfiguration.Builder> engineConfiguration)

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

      This is a convenience method that creates an instance of the EngineConfiguration.Builder avoiding the need to create one manually via EngineConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to engineConfiguration(EngineConfiguration).

      Parameters:
      engineConfiguration - a consumer that will call methods on EngineConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notebookVersion

      StartSessionRequest.Builder notebookVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • sessionIdleTimeoutInMinutes

      StartSessionRequest.Builder sessionIdleTimeoutInMinutes(Integer sessionIdleTimeoutInMinutes)

      The idle timeout in minutes for the session.

      Parameters:
      sessionIdleTimeoutInMinutes - The idle timeout in minutes for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      StartSessionRequest.Builder clientRequestToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.