Class Session
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.Session
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Session.Builder,Session>
@Generated("software.amazon.awssdk:codegen") public final class Session extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Session.Builder,Session>
The period in which a remote Spark runtime environment is running.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Session.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Session.Builder
builder()
SessionCommand
command()
The command object.See SessionCommand.Instant
completedOn()
The date and time that this session is completed.ConnectionsList
connections()
The number of connections used for the session.Instant
createdOn()
The time and date when the session was created.Map<String,String>
defaultArguments()
A map array of key-value pairs.String
description()
The description of the session.Double
dpuSeconds()
The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
errorMessage()
The error message displayed during the session.Double
executionTime()
The total time the session ran for.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
String
glueVersion()
The Glue version determines the versions of Apache Spark and Python that Glue supports.boolean
hasDefaultArguments()
For responses, this returns true if the service returned a value for the DefaultArguments property.int
hashCode()
String
id()
The ID of the session.Integer
idleTimeout()
The number of minutes when idle before the session times out.Double
maxCapacity()
The number of Glue data processing units (DPUs) that can be allocated when the job runs.Integer
numberOfWorkers()
The number of workers of a definedWorkerType
to use for the session.Double
progress()
The code execution progress of the session.String
role()
The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.List<SdkField<?>>
sdkFields()
String
securityConfiguration()
The name of the SecurityConfiguration structure to be used with the session.static Class<? extends Session.Builder>
serializableBuilderClass()
SessionStatus
status()
The session status.String
statusAsString()
The session status.Session.Builder
toBuilder()
String
toString()
Returns a string representation of this object.WorkerType
workerType()
The type of predefined worker that is allocated when a session runs.String
workerTypeAsString()
The type of predefined worker that is allocated when a session runs.-
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
-
id
public final String id()
The ID of the session.
- Returns:
- The ID of the session.
-
createdOn
public final Instant createdOn()
The time and date when the session was created.
- Returns:
- The time and date when the session was created.
-
status
public final SessionStatus status()
The session status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSessionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The session status.
- See Also:
SessionStatus
-
statusAsString
public final String statusAsString()
The session status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSessionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The session status.
- See Also:
SessionStatus
-
errorMessage
public final String errorMessage()
The error message displayed during the session.
- Returns:
- The error message displayed during the session.
-
description
public final String description()
The description of the session.
- Returns:
- The description of the session.
-
role
public final String role()
The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
- Returns:
- The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
-
command
public final SessionCommand command()
The command object.See SessionCommand.
- Returns:
- The command object.See SessionCommand.
-
hasDefaultArguments
public final boolean hasDefaultArguments()
For responses, this returns true if the service returned a value for the DefaultArguments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
defaultArguments
public final Map<String,String> defaultArguments()
A map array of key-value pairs. Max is 75 pairs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDefaultArguments()
method.- Returns:
- A map array of key-value pairs. Max is 75 pairs.
-
connections
public final ConnectionsList connections()
The number of connections used for the session.
- Returns:
- The number of connections used for the session.
-
progress
public final Double progress()
The code execution progress of the session.
- Returns:
- The code execution progress of the session.
-
maxCapacity
public final 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.
- Returns:
- 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.
-
securityConfiguration
public final String securityConfiguration()
The name of the SecurityConfiguration structure to be used with the session.
- Returns:
- The name of the SecurityConfiguration structure to be used with the session.
-
glueVersion
public final String glueVersion()
The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
- Returns:
- The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
-
numberOfWorkers
public final Integer numberOfWorkers()
The number of workers of a defined
WorkerType
to use for the session.- Returns:
- The number of workers of a defined
WorkerType
to use for the session.
-
workerType
public final 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.8X
for Spark sessions. Accepts the valueZ.2X
for Ray sessions.If the service returns an enum value that is not available in the current SDK version,
workerType
will returnWorkerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromworkerTypeAsString()
.- Returns:
- 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. - See Also:
WorkerType
-
workerTypeAsString
public final String workerTypeAsString()
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.If the service returns an enum value that is not available in the current SDK version,
workerType
will returnWorkerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromworkerTypeAsString()
.- Returns:
- 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. - See Also:
WorkerType
-
completedOn
public final Instant completedOn()
The date and time that this session is completed.
- Returns:
- The date and time that this session is completed.
-
executionTime
public final Double executionTime()
The total time the session ran for.
- Returns:
- The total time the session ran for.
-
dpuSeconds
public final Double dpuSeconds()
The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
- Returns:
- The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
-
idleTimeout
public final Integer idleTimeout()
The number of minutes when idle before the session times out.
- Returns:
- The number of minutes when idle before the session times out.
-
toBuilder
public Session.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Session.Builder,Session>
-
builder
public static Session.Builder builder()
-
serializableBuilderClass
public static Class<? extends Session.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-