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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TaskSearchSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TaskSearchSummary.Builder`	`builder()`
`Instant`	`endedAt()`	The date and time the resource ended running.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`failureRetryCount()`	The number of times that the task failed and was retried.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()`	For responses, this returns true if the service returned a value for the Parameters property.
`String`	`jobId()`	The job ID.
`Map<String,TaskParameterValue>`	`parameters()`	The parameters to search for.
`String`	`queueId()`	The queue ID.
`TaskRunStatus`	`runStatus()`	The run status of the task.
`String`	`runStatusAsString()`	The run status of the task.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TaskSearchSummary.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()`	The date and time the resource started running.
`String`	`stepId()`	The step ID.
`TaskTargetRunStatus`	`targetRunStatus()`	The run status that the task is being updated to.
`String`	`targetRunStatusAsString()`	The run status that the task is being updated to.
`String`	`taskId()`	The task ID.
`TaskSearchSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - endedAt
```
public final Instant endedAt()
```
    The date and time the resource ended running.
    
    Returns:
    
    The date and time the resource ended running.
  - 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.
  - jobId
```
public final String jobId()
```
    The job ID.
    
    Returns:
    
    The job ID.
  - 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.
  - 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:
    
    TaskRunStatus
  - 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:
    
    TaskRunStatus
  - startedAt
```
public final Instant startedAt()
```
    The date and time the resource started running.
    
    Returns:
    
    The date and time the resource started running.
  - stepId
```
public final String stepId()
```
    The step ID.
    
    Returns:
    
    The step ID.
  - 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:
    
    TaskTargetRunStatus
  - 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:
    
    TaskTargetRunStatus
  - taskId
```
public final String taskId()
```
    The task ID.
    
    Returns:
    
    The task ID.
  - toBuilder
```
public TaskSearchSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TaskSearchSummary.Builder,TaskSearchSummary>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class TaskSearchSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

endedAt

failureRetryCount

jobId

hasParameters

parameters

queueId

runStatus

runStatusAsString

startedAt

stepId

targetRunStatus

targetRunStatusAsString

taskId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields