Interface Session.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Session.Builder,Session>,SdkBuilder<Session.Builder,Session>,SdkPojo
- Enclosing class:
- Session
public static interface Session.Builder extends SdkPojo, CopyableBuilder<Session.Builder,Session>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Session.Buildercommand(Consumer<SessionCommand.Builder> command)The command object.See SessionCommand.Session.Buildercommand(SessionCommand command)The command object.See SessionCommand.Session.BuildercompletedOn(Instant completedOn)The date and time that this session is completed.default Session.Builderconnections(Consumer<ConnectionsList.Builder> connections)The number of connections used for the session.Session.Builderconnections(ConnectionsList connections)The number of connections used for the session.Session.BuildercreatedOn(Instant createdOn)The time and date when the session was created.Session.BuilderdefaultArguments(Map<String,String> defaultArguments)A map array of key-value pairs.Session.Builderdescription(String description)The description of the session.Session.BuilderdpuSeconds(Double dpuSeconds)The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).Session.BuildererrorMessage(String errorMessage)The error message displayed during the session.Session.BuilderexecutionTime(Double executionTime)The total time the session ran for.Session.BuilderglueVersion(String glueVersion)The Glue version determines the versions of Apache Spark and Python that Glue supports.Session.Builderid(String id)The ID of the session.Session.BuilderidleTimeout(Integer idleTimeout)The number of minutes when idle before the session times out.Session.BuildermaxCapacity(Double maxCapacity)The number of Glue data processing units (DPUs) that can be allocated when the job runs.Session.BuildernumberOfWorkers(Integer numberOfWorkers)The number of workers of a definedWorkerTypeto use for the session.Session.BuilderprofileName(String profileName)The name of an Glue usage profile associated with the session.Session.Builderprogress(Double progress)The code execution progress of the session.Session.Builderrole(String role)The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.Session.BuildersecurityConfiguration(String securityConfiguration)The name of the SecurityConfiguration structure to be used with the session.Session.Builderstatus(String status)The session status.Session.Builderstatus(SessionStatus status)The session status.Session.BuilderworkerType(String workerType)The type of predefined worker that is allocated when a session runs.Session.BuilderworkerType(WorkerType workerType)The type of predefined worker that is allocated when a session runs.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
id
Session.Builder id(String 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:
SessionStatus,SessionStatus
-
status
Session.Builder status(SessionStatus 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:
SessionStatus,SessionStatus
-
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 theSessionCommand.Builderavoiding the need to create one manually viaSessionCommand.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocommand(SessionCommand).- Parameters:
command- a consumer that will call methods onSessionCommand.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
command(SessionCommand)
-
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 theConnectionsList.Builderavoiding the need to create one manually viaConnectionsList.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconnections(ConnectionsList).- Parameters:
connections- a consumer that will call methods onConnectionsList.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
connections(ConnectionsList)
-
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
WorkerTypeto use for the session.- Parameters:
numberOfWorkers- The number of workers of a definedWorkerTypeto 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, orG.8Xfor Spark sessions. Accepts the valueZ.2Xfor Ray sessions.- Parameters:
workerType- The type of predefined worker that is allocated when a session runs. Accepts a value ofG.1X,G.2X,G.4X, orG.8Xfor Spark sessions. Accepts the valueZ.2Xfor Ray sessions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorkerType,WorkerType
-
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, orG.8Xfor Spark sessions. Accepts the valueZ.2Xfor Ray sessions.- Parameters:
workerType- The type of predefined worker that is allocated when a session runs. Accepts a value ofG.1X,G.2X,G.4X, orG.8Xfor Spark sessions. Accepts the valueZ.2Xfor Ray sessions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorkerType,WorkerType
-
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.
-
-