Interface Session.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Session.Builder,
,Session> SdkBuilder<Session.Builder,
,Session> SdkPojo
- Enclosing class:
Session
-
Method Summary
Modifier and TypeMethodDescriptiondefault Session.Builder
command
(Consumer<SessionCommand.Builder> command) The command object.See SessionCommand.command
(SessionCommand command) The command object.See SessionCommand.completedOn
(Instant completedOn) The date and time that this session is completed.default Session.Builder
connections
(Consumer<ConnectionsList.Builder> connections) The number of connections used for the session.connections
(ConnectionsList connections) The number of connections used for the session.The time and date when the session was created.defaultArguments
(Map<String, String> defaultArguments) A map array of key-value pairs.description
(String description) The description of the session.dpuSeconds
(Double dpuSeconds) The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).errorMessage
(String errorMessage) The error message displayed during the session.executionTime
(Double executionTime) The total time the session ran for.glueVersion
(String glueVersion) The Glue version determines the versions of Apache Spark and Python that Glue supports.The ID of the session.idleTimeout
(Integer idleTimeout) The number of minutes when idle before the session times out.maxCapacity
(Double maxCapacity) The number of Glue data processing units (DPUs) that can be allocated when the job runs.numberOfWorkers
(Integer numberOfWorkers) The number of workers of a definedWorkerType
to use for the session.profileName
(String profileName) The name of an Glue usage profile associated with the session.The code execution progress of the session.The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.securityConfiguration
(String securityConfiguration) The name of the SecurityConfiguration structure to be used with the session.The session status.status
(SessionStatus status) The session status.workerType
(String workerType) The type of predefined worker that is allocated when a session runs.workerType
(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, sdkFieldNameToField, sdkFields
-
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
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
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
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
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
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
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
The command object.See SessionCommand.
This is a convenience method that creates an instance of theSessionCommand.Builder
avoiding the need to create one manually viaSessionCommand.builder()
.When the
Consumer
completes,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:
-
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
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
The number of connections used for the session.
This is a convenience method that creates an instance of theConnectionsList.Builder
avoiding the need to create one manually viaConnectionsList.builder()
.When the
Consumer
completes,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:
-
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
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
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
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
The number of workers of a defined
WorkerType
to use for the session.- Parameters:
numberOfWorkers
- The number of workers of a definedWorkerType
to use for the session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workerType
The type of predefined worker that is allocated when a session runs. Accepts a value of
G.1X
,G.2X
,G.4X
, orG.8X
for Spark sessions. Accepts the valueZ.2X
for 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.8X
for Spark sessions. Accepts the valueZ.2X
for Ray sessions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
workerType
The type of predefined worker that is allocated when a session runs. Accepts a value of
G.1X
,G.2X
,G.4X
, orG.8X
for Spark sessions. Accepts the valueZ.2X
for 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.8X
for Spark sessions. Accepts the valueZ.2X
for Ray sessions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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.
-