Class TaskSearchSummary

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

The details of a task search.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The task ID.

      Returns:
      The task ID.

    • stepId

      public final String stepId()

      The step ID.

      Returns:
      The step ID.

    • jobId

      public final String jobId()

      The job ID.

      Returns:
      The job ID.

    • queueId

      public final String queueId()

      The queue ID.

      Returns:
      The queue ID.

    • runStatus

      public final TaskRunStatus runStatus()

      The run status of the task.

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

      Returns:
      The run status of the task.
      See Also:

    • runStatusAsString

      public final String runStatusAsString()

      The run status of the task.

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

      Returns:
      The run status of the task.
      See Also:

    • targetRunStatus

      public final TaskTargetRunStatus targetRunStatus()

      The run status that the task is being updated to.

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

      Returns:
      The run status that the task is being updated to.
      See Also:

    • targetRunStatusAsString

      public final String targetRunStatusAsString()

      The run status that the task is being updated to.

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

      Returns:
      The run status that the task is being updated to.
      See Also:

    • hasParameters

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

    • parameters

      public final Map<String,TaskParameterValue> parameters()

      The parameters to search for.

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

      Returns:
      The parameters to search for.

    • failureRetryCount

      public final Integer failureRetryCount()

      The number of times that the task failed and was retried.

      Returns:
      The number of times that the task failed and was retried.

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

    • toBuilder

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

    • builder

      public static TaskSearchSummary.Builder builder()

    • serializableBuilderClass

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