Class Session
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Session.Builder,Session>
Information about a session, including the session state, configuration, and timestamps.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe ID of the application that the session belongs to.final Stringarn()The Amazon Resource Name (ARN) of the session.final ResourceUtilizationThe aggregate vCPU, memory, and storage that Amazon Web Services has billed for the session.static Session.Builderbuilder()The configuration overrides for the session, including runtime configuration properties.final InstantThe date and time that the session was created.final StringThe IAM principal that created the session.final InstantendedAt()The date and time that the session was terminated or failed.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringThe Amazon Resource Name (ARN) of the execution role for the session.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final InstantThe date and time that the session became idle.final LongThe idle timeout in minutes for the session.final Stringname()The optional name of the session.final NetworkConfigurationThe network configuration for customer VPC connectivity for the session.final StringThe Amazon EMR release label associated with the session.static Class<? extends Session.Builder> final StringThe ID of the session.final InstantThe date and time that the session moved to a running state.final SessionStatestate()The state of the session.final StringThe state of the session.final StringAdditional details about the current state of the session.tags()The tags assigned to the session.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final LongThe total execution duration of the session in seconds.final TotalResourceUtilizationThe aggregate vCPU, memory, and storage resources used from the time the session starts to execute, until the time the session terminates, rounded up to the nearest second.final InstantThe date and time that the session was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The ID of the application that the session belongs to.
- Returns:
- The ID of the application that the session belongs to.
-
sessionId
-
arn
The Amazon Resource Name (ARN) of the session.
- Returns:
- The Amazon Resource Name (ARN) of the session.
-
name
The optional name of the session.
- Returns:
- The optional name of the session.
-
state
The state of the session.
If the service returns an enum value that is not available in the current SDK version,
statewill returnSessionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the session.
- See Also:
-
stateAsString
The state of the session.
If the service returns an enum value that is not available in the current SDK version,
statewill returnSessionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the session.
- See Also:
-
stateDetails
Additional details about the current state of the session.
- Returns:
- Additional details about the current state of the session.
-
releaseLabel
The Amazon EMR release label associated with the session.
- Returns:
- The Amazon EMR release label associated with the session.
-
executionRoleArn
The Amazon Resource Name (ARN) of the execution role for the session.
- Returns:
- The Amazon Resource Name (ARN) of the execution role for the session.
-
createdBy
The IAM principal that created the session.
- Returns:
- The IAM principal that created the session.
-
createdAt
The date and time that the session was created.
- Returns:
- The date and time that the session was created.
-
updatedAt
The date and time that the session was last updated.
- Returns:
- The date and time that the session was last updated.
-
startedAt
The date and time that the session moved to a running state.
- Returns:
- The date and time that the session moved to a running state.
-
endedAt
The date and time that the session was terminated or failed.
- Returns:
- The date and time that the session was terminated or failed.
-
idleSince
The date and time that the session became idle.
- Returns:
- The date and time that the session became idle.
-
configurationOverrides
The configuration overrides for the session, including runtime configuration properties.
- Returns:
- The configuration overrides for the session, including runtime configuration properties.
-
networkConfiguration
The network configuration for customer VPC connectivity for the session.
- Returns:
- The network configuration for customer VPC connectivity for the session.
-
idleTimeoutMinutes
The idle timeout in minutes for the session. After the session remains idle for this duration, it is automatically terminated.
- Returns:
- The idle timeout in minutes for the session. After the session remains idle for this duration, it is automatically terminated.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
The tags assigned to the session.
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
hasTags()method.- Returns:
- The tags assigned to the session.
-
totalResourceUtilization
The aggregate vCPU, memory, and storage resources used from the time the session starts to execute, until the time the session terminates, rounded up to the nearest second.
- Returns:
- The aggregate vCPU, memory, and storage resources used from the time the session starts to execute, until the time the session terminates, rounded up to the nearest second.
-
billedResourceUtilization
The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the session. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.
- Returns:
- The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the session. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.
-
totalExecutionDurationSeconds
The total execution duration of the session in seconds.
- Returns:
- The total execution duration of the session in seconds.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<Session.Builder,Session> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-