Class GetSessionActionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.deadline.model.DeadlineResponse
software.amazon.awssdk.services.deadline.model.GetSessionActionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSessionActionResponse.Builder,GetSessionActionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetSessionActionResponse extends DeadlineResponse implements ToCopyableBuilder<GetSessionActionResponse.Builder,GetSessionActionResponse>

  • Method Details

    • sessionActionId

      public final String sessionActionId()

      The session action ID.

      Returns:
      The session action ID.

    • status

      public final SessionActionStatus status()

      The status of the session action.

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

      Returns:
      The status of the session action.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the session action.

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

      Returns:
      The status of the session action.
      See Also:

    • 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.

    • workerUpdatedAt

      public final Instant workerUpdatedAt()

      The Linux timestamp of the date and time the session action was last updated.

      Returns:
      The Linux timestamp of the date and time the session action was last updated.

    • progressPercent

      public final Float progressPercent()

      The percentage completed for a session action.

      Returns:
      The percentage completed for a session action.

    • sessionId

      public final String sessionId()

      The session ID for the session action.

      Returns:
      The session ID for the session action.

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

      The message that communicates the progress of the session action.

      Returns:
      The message that communicates the progress of the session action.

    • definition

      public final SessionActionDefinition definition()

      The session action definition.

      Returns:
      The session action definition.

    • hasAcquiredLimits

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

    • acquiredLimits

      public final List<AcquiredLimit> acquiredLimits()

      The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.

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

      Returns:
      The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.

    • 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<TaskRunManifestPropertiesResponse> manifests()

      The list of manifest properties that describe file attachments for the task run.

      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:
      The list of manifest properties that describe file attachments for the task run.

    • toBuilder

      public GetSessionActionResponse.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<GetSessionActionResponse.Builder,GetSessionActionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetSessionActionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.