java.lang.Object
- software.amazon.awssdk.services.deadline.model.JobSearchSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<JobSearchSummary.Builder,JobSearchSummary>

@Generated("software.amazon.awssdk:codegen")
public final class JobSearchSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobSearchSummary.Builder,JobSearchSummary>

The details of a job search.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface JobSearchSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JobSearchSummary.Builder`	`builder()`
`Instant`	`createdAt()`	The date and time the resource was created.
`String`	`createdBy()`	The user or system that created this resource.
`Instant`	`endedAt()`	The date and time the resource ended running.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasJobParameters()`	For responses, this returns true if the service returned a value for the JobParameters property.
`boolean`	`hasTaskRunStatusCounts()`	For responses, this returns true if the service returned a value for the TaskRunStatusCounts property.
`String`	`jobId()`	The job ID.
`Map<String,JobParameter>`	`jobParameters()`	The job parameters.
`JobLifecycleStatus`	`lifecycleStatus()`	The life cycle status.
`String`	`lifecycleStatusAsString()`	The life cycle status.
`String`	`lifecycleStatusMessage()`	The life cycle status message.
`Integer`	`maxFailedTasksCount()`	The number of task failures before the job stops running and is marked as `FAILED`.
`Integer`	`maxRetriesPerTask()`	The maximum number of retries for a job.
`String`	`name()`	The job name.
`Integer`	`priority()`	The job priority.
`String`	`queueId()`	The queue ID.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobSearchSummary.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()`	The date and time the resource started running.
`JobTargetTaskRunStatus`	`targetTaskRunStatus()`	The task status to start with on the job.
`String`	`targetTaskRunStatusAsString()`	The task status to start with on the job.
`TaskRunStatus`	`taskRunStatus()`	task run status for the job.
`String`	`taskRunStatusAsString()`	task run status for the job.
`Map<TaskRunStatus,Integer>`	`taskRunStatusCounts()`	The number of tasks running on the job.
`Map<String,Integer>`	`taskRunStatusCountsAsStrings()`	The number of tasks running on the job.
`JobSearchSummary.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
  - createdAt
```
public final Instant createdAt()
```
    The date and time the resource was created.
    
    Returns:
    
    The date and time the resource was created.
  - createdBy
```
public final String createdBy()
```
    The user or system that created this resource.
    
    Returns:
    
    The user or system that created this resource.
  - endedAt
```
public final Instant endedAt()
```
    The date and time the resource ended running.
    
    Returns:
    
    The date and time the resource ended running.
  - jobId
```
public final String jobId()
```
    The job ID.
    
    Returns:
    
    The job ID.
  - hasJobParameters
```
public final boolean hasJobParameters()
```
    For responses, this returns true if the service returned a value for the JobParameters 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.
  - jobParameters
```
public final Map<String,JobParameter> jobParameters()
```
    The job parameters.
    
    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 hasJobParameters() method.
    
    Returns:
    
    The job parameters.
  - lifecycleStatus
```
public final JobLifecycleStatus lifecycleStatus()
```
    The life cycle status.
    
    If the service returns an enum value that is not available in the current SDK version, lifecycleStatus will return JobLifecycleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStatusAsString().
    
    Returns:
    
    The life cycle status.
    
    See Also:
    
    JobLifecycleStatus
  - lifecycleStatusAsString
```
public final String lifecycleStatusAsString()
```
    The life cycle status.
    
    If the service returns an enum value that is not available in the current SDK version, lifecycleStatus will return JobLifecycleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStatusAsString().
    
    Returns:
    
    The life cycle status.
    
    See Also:
    
    JobLifecycleStatus
  - lifecycleStatusMessage
```
public final String lifecycleStatusMessage()
```
    The life cycle status message.
    
    Returns:
    
    The life cycle status message.
  - maxFailedTasksCount
```
public final Integer maxFailedTasksCount()
```
    The number of task failures before the job stops running and is marked as FAILED.
    
    Returns:
    
    The number of task failures before the job stops running and is marked as FAILED.
  - maxRetriesPerTask
```
public final Integer maxRetriesPerTask()
```
    The maximum number of retries for a job.
    
    Returns:
    
    The maximum number of retries for a job.
  - name
```
public final String name()
```
    The job name.
    
    Returns:
    
    The job name.
  - priority
```
public final Integer priority()
```
    The job priority.
    
    Returns:
    
    The job priority.
  - queueId
```
public final String queueId()
```
    The queue ID.
    
    Returns:
    
    The queue ID.
  - startedAt
```
public final Instant startedAt()
```
    The date and time the resource started running.
    
    Returns:
    
    The date and time the resource started running.
  - targetTaskRunStatus
```
public final JobTargetTaskRunStatus targetTaskRunStatus()
```
    The task status to start with on the job.
    
    If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return JobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().
    
    Returns:
    
    The task status to start with on the job.
    
    See Also:
    
    JobTargetTaskRunStatus
  - targetTaskRunStatusAsString
```
public final String targetTaskRunStatusAsString()
```
    The task status to start with on the job.
    
    If the service returns an enum value that is not available in the current SDK version, targetTaskRunStatus will return JobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTaskRunStatusAsString().
    
    Returns:
    
    The task status to start with on the job.
    
    See Also:
    
    JobTargetTaskRunStatus
  - taskRunStatus
```
public final TaskRunStatus taskRunStatus()
```
    task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    
    If the service returns an enum value that is not available in the current SDK version, taskRunStatus will return TaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskRunStatusAsString().
    Returns:
    
    task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    
    See Also:
    
    TaskRunStatus
  - taskRunStatusAsString
```
public final String taskRunStatusAsString()
```
    task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    
    If the service returns an enum value that is not available in the current SDK version, taskRunStatus will return TaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskRunStatusAsString().
    Returns:
    
    task run status for the job.
    
    PENDING–pending and waiting for resources.
    
    READY–ready to be processed.
    
    ASSIGNED–assigned and will run next on a worker.
    
    SCHEDULED–scheduled to be run on a worker.
    
    INTERRUPTING–being interrupted.
    
    RUNNING–running on a worker.
    
    SUSPENDED–the task is suspended.
    
    CANCELED–the task has been canceled.
    
    FAILED–the task has failed.
    
    SUCCEEDED–the task has succeeded.
    
    See Also:
    
    TaskRunStatus
  - taskRunStatusCounts
```
public final Map<TaskRunStatus,Integer> taskRunStatusCounts()
```
    The number of tasks running on 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 hasTaskRunStatusCounts() method.
    
    Returns:
    
    The number of tasks running on the job.
  - hasTaskRunStatusCounts
```
public final boolean hasTaskRunStatusCounts()
```
    For responses, this returns true if the service returned a value for the TaskRunStatusCounts 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.
  - taskRunStatusCountsAsStrings
```
public final Map<String,Integer> taskRunStatusCountsAsStrings()
```
    The number of tasks running on 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 hasTaskRunStatusCounts() method.
    
    Returns:
    
    The number of tasks running on the job.
  - toBuilder
```
public JobSearchSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobSearchSummary.Builder,JobSearchSummary>
  - builder
```
public static JobSearchSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobSearchSummary.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 JobSearchSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

createdAt

createdBy

endedAt

jobId

hasJobParameters

jobParameters

lifecycleStatus

lifecycleStatusAsString

lifecycleStatusMessage

maxFailedTasksCount

maxRetriesPerTask

name

priority

queueId

startedAt

targetTaskRunStatus

targetTaskRunStatusAsString

taskRunStatus

taskRunStatusAsString

taskRunStatusCounts

hasTaskRunStatusCounts

taskRunStatusCountsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields