Class BatchGetSessionActionItem

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

The details of a session action returned in a batch get operation.

See Also:

  • Method Details

    • farmId

      public final String farmId()

      The farm ID of the session action.

      Returns:
      The farm ID of the session action.

    • queueId

      public final String queueId()

      The queue ID of the session action.

      Returns:
      The queue ID of the session action.

    • jobId

      public final String jobId()

      The job ID of the session action.

      Returns:
      The job ID of the session action.

    • 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 date and time the resource was updated by a worker.

      Returns:
      The date and time the resource was updated by a worker.

    • progressPercent

      public final Float progressPercent()

      The completion percentage for the session action.

      Returns:
      The completion percentage for the session action.

    • 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 manifests for the session action.

      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 manifests for the 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 exit code to apply to the session action.

      Returns:
      The exit code to apply to the session action.

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

    • 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 that were acquired for the session action.

      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 that were acquired for the session action.

    • definition

      public final SessionActionDefinition definition()

      The session action definition.

      Returns:
      The session action definition.

    • toBuilder

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

    • builder

      public static BatchGetSessionActionItem.Builder builder()

    • serializableBuilderClass

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