Interface Session.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Session.Builder,Session>, SdkBuilder<Session.Builder,Session>, SdkPojo
Enclosing class:
Session

@Mutable @NotThreadSafe public static interface Session.Builder extends SdkPojo, CopyableBuilder<Session.Builder,Session>
  • Method Details

    • id

      The ID of the session.

      Parameters:
      id - The ID of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdOn

      Session.Builder createdOn(Instant createdOn)

      The time and date when the session was created.

      Parameters:
      createdOn - The time and date when the session was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      Session.Builder status(String status)

      The session status.

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

      The session status.

      Parameters:
      status - The session status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • errorMessage

      Session.Builder errorMessage(String errorMessage)

      The error message displayed during the session.

      Parameters:
      errorMessage - The error message displayed during the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      Session.Builder description(String description)

      The description of the session.

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

      Session.Builder role(String role)

      The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

      Parameters:
      role - The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • command

      Session.Builder command(SessionCommand command)

      The command object.See SessionCommand.

      Parameters:
      command - The command object.See SessionCommand.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • command

      default Session.Builder command(Consumer<SessionCommand.Builder> command)

      The command object.See SessionCommand.

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

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

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

      Session.Builder defaultArguments(Map<String,String> defaultArguments)

      A map array of key-value pairs. Max is 75 pairs.

      Parameters:
      defaultArguments - A map array of key-value pairs. Max is 75 pairs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • connections

      Session.Builder connections(ConnectionsList connections)

      The number of connections used for the session.

      Parameters:
      connections - The number of connections used for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • connections

      default Session.Builder connections(Consumer<ConnectionsList.Builder> connections)

      The number of connections used for the session.

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

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

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

      Session.Builder progress(Double progress)

      The code execution progress of the session.

      Parameters:
      progress - The code execution progress of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxCapacity

      Session.Builder maxCapacity(Double maxCapacity)

      The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

      Parameters:
      maxCapacity - The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • securityConfiguration

      Session.Builder securityConfiguration(String securityConfiguration)

      The name of the SecurityConfiguration structure to be used with the session.

      Parameters:
      securityConfiguration - The name of the SecurityConfiguration structure to be used with the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • glueVersion

      Session.Builder glueVersion(String glueVersion)

      The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

      Parameters:
      glueVersion - The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • numberOfWorkers

      Session.Builder numberOfWorkers(Integer numberOfWorkers)

      The number of workers of a defined WorkerType to use for the session.

      Parameters:
      numberOfWorkers - The number of workers of a defined WorkerType to use for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • workerType

      Session.Builder workerType(String workerType)

      The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.

      Parameters:
      workerType - The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • workerType

      Session.Builder workerType(WorkerType workerType)

      The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.

      Parameters:
      workerType - The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • completedOn

      Session.Builder completedOn(Instant completedOn)

      The date and time that this session is completed.

      Parameters:
      completedOn - The date and time that this session is completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • executionTime

      Session.Builder executionTime(Double executionTime)

      The total time the session ran for.

      Parameters:
      executionTime - The total time the session ran for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dpuSeconds

      Session.Builder dpuSeconds(Double dpuSeconds)

      The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).

      Parameters:
      dpuSeconds - The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • idleTimeout

      Session.Builder idleTimeout(Integer idleTimeout)

      The number of minutes when idle before the session times out.

      Parameters:
      idleTimeout - The number of minutes when idle before the session times out.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • profileName

      Session.Builder profileName(String profileName)

      The name of an Glue usage profile associated with the session.

      Parameters:
      profileName - The name of an Glue usage profile associated with the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.