Class Session

java.lang.Object
software.amazon.awssdk.services.emr.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>

Detailed information about a Spark Connect session.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the session.

      Returns:
      The ID of the session.

    • clusterId

      public final String clusterId()

      The ID of the cluster that the session belongs to.

      Returns:
      The ID of the cluster that the session belongs to.

    • name

      public final String name()

      The name of the session, if one was provided at creation time.

      Returns:
      The name of the session, if one was provided at creation time.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the session.

      Returns:
      The Amazon Resource Name (ARN) of the session.

    • state

      public final SessionState state()

      The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.

      If the service returns an enum value that is not available in the current SDK version, state will return SessionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.

      If the service returns an enum value that is not available in the current SDK version, state will return SessionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.
      See Also:

    • stateChangeReason

      public final String stateChangeReason()

      A human-readable message describing the most recent state change.

      Returns:
      A human-readable message describing the most recent state change.

    • releaseLabel

      public final String releaseLabel()

      The Amazon EMR release label of the cluster that the session is running on.

      Returns:
      The Amazon EMR release label of the cluster that the session is running on.

    • executionRoleArn

      public final String executionRoleArn()

      The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

      Returns:
      The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

    • accountId

      public final String accountId()

      The Amazon Web Services account ID that owns the session.

      Returns:
      The Amazon Web Services account ID that owns the session.

    • createdAt

      public final Instant createdAt()

      The date and time that the session was created.

      Returns:
      The date and time that the session was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time that the session was last updated.

      Returns:
      The date and time that the session was last updated.

    • startedAt

      public final Instant startedAt()

      The date and time that the session entered the STARTED state.

      Returns:
      The date and time that the session entered the STARTED state.

    • endedAt

      public final Instant 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

      public final Instant idleSince()

      The date and time that the session last entered the IDLE state.

      Returns:
      The date and time that the session last entered the IDLE state.

    • hasEngineConfigurations

      public final boolean hasEngineConfigurations()
      For responses, this returns true if the service returned a value for the EngineConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • engineConfigurations

      public final List<Configuration> engineConfigurations()

      The configuration overrides for the session. Only runtime configuration overrides are supported.

      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 hasEngineConfigurations() method.

      Returns:
      The configuration overrides for the session. Only runtime configuration overrides are supported.

    • monitoringConfiguration

      public final SessionMonitoringConfiguration monitoringConfiguration()

      The monitoring configuration for the session.

      Returns:
      The monitoring configuration for the session.

    • sessionIdleTimeoutInMinutes

      public final Long sessionIdleTimeoutInMinutes()

      The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.

      Returns:
      The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.

    • certificateAuthority

      public final CertificateAuthority certificateAuthority()

      The certificate authority used to establish an mTLS connection to the Spark Connect server when connecting directly over VPC peering.

      Returns:
      The certificate authority used to establish an mTLS connection to the Spark Connect server when connecting directly over VPC peering.

    • serverUrl

      public final String serverUrl()

      The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering.

      Returns:
      The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering.

    • 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 the isEmpty() 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

      public final List<Tag> tags()

      The tags associated with 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 associated with the session.

    • toBuilder

      public Session.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Session.Builder,Session>
      Returns:
      a builder for type T

    • builder

      public static Session.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Session.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.