Class WorkerSessionSummary

java.lang.Object
software.amazon.awssdk.services.deadline.model.WorkerSessionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkerSessionSummary.Builder,WorkerSessionSummary>
@Generated("software.amazon.awssdk:codegen") public final class WorkerSessionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkerSessionSummary.Builder,WorkerSessionSummary>

Summarizes the session for a particular worker.

See Also:

  • Method Details

    • sessionId

      public final String sessionId()

      The session ID for the session action.

      Returns:
      The session ID for the session action.

    • queueId

      public final String queueId()

      The queue ID for the queue associated to the worker.

      Returns:
      The queue ID for the queue associated to the worker.

    • jobId

      public final String jobId()

      The job ID for the job associated with the worker's session.

      Returns:
      The job ID for the job associated with the worker's session.

    • startedAt

      public final Instant startedAt()

      The date and time the resource started running.

      Returns:
      The date and time the resource started running.

    • lifecycleStatus

      public final SessionLifecycleStatus lifecycleStatus()

      The life cycle status for the worker's session.

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

      Returns:
      The life cycle status for the worker's session.
      See Also:

    • lifecycleStatusAsString

      public final String lifecycleStatusAsString()

      The life cycle status for the worker's session.

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

      Returns:
      The life cycle status for the worker's session.
      See Also:

    • endedAt

      public final Instant endedAt()

      The date and time the resource ended running.

      Returns:
      The date and time the resource ended running.

    • targetLifecycleStatus

      public final SessionLifecycleTargetStatus targetLifecycleStatus()

      The life cycle status

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

      Returns:
      The life cycle status
      See Also:

    • targetLifecycleStatusAsString

      public final String targetLifecycleStatusAsString()

      The life cycle status

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

      Returns:
      The life cycle status
      See Also:

    • toBuilder

      public WorkerSessionSummary.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<WorkerSessionSummary.Builder,WorkerSessionSummary>
      Returns:
      a builder for type T

    • builder

      public static WorkerSessionSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkerSessionSummary.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.