Class UpdatedSessionActionInfo

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

The updated session action information as it relates to completion and progress of the session.

See Also:

  • Method Details

    • completedStatus

      public final CompletedStatus completedStatus()

      The status of the session upon completion.

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

      Returns:
      The status of the session upon completion.
      See Also:

    • completedStatusAsString

      public final String completedStatusAsString()

      The status of the session upon completion.

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

      Returns:
      The status of the session upon completion.
      See Also:

    • processExitCode

      public final Integer processExitCode()

      The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.

      Returns:
      The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.

    • progressMessage

      public final String progressMessage()

      A message to indicate the progress of the updated session action.

      Returns:
      A message to indicate the progress of the updated session action.

    • startedAt

      public final Instant startedAt()

      The date and time the resource started running.

      Returns:
      The date and time the resource started running.

    • endedAt

      public final Instant endedAt()

      The date and time the resource ended running.

      Returns:
      The date and time the resource ended running.

    • updatedAt

      public final Instant updatedAt()

      The updated time.

      Returns:
      The updated time.

    • progressPercent

      public final Float progressPercent()

      The percentage completed.

      Returns:
      The percentage completed.

    • hasManifests

      public final boolean hasManifests()
      For responses, this returns true if the service returned a value for the Manifests 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.

    • manifests

      public final List<TaskRunManifestPropertiesRequest> manifests()

      A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job.

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

      Returns:
      A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job.

    • toBuilder

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

    • builder

      public static UpdatedSessionActionInfo.Builder builder()

    • serializableBuilderClass

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