Package software.amazon.awssdk.services.deadline.model

Class TaskSummary

java.lang.Object

software.amazon.awssdk.services.deadline.model.TaskSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskSummary.Builder,TaskSummary>

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

The details of a task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TaskSummary.Builder

Method Summary

Modifier and Type	Method	Description
static TaskSummary.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)
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	latestSessionActionId()	The latest session action for the task.
Map<String,TaskParameterValue>	parameters()	The task parameters.
TaskRunStatus	runStatus()	The run status of the task.
String	runStatusAsString()	The run status of the task.
List<SdkField<?>>	sdkFields()
static Class<? extends TaskSummary.Builder>	serializableBuilderClass()
Instant	startedAt()	The date and time the resource started running.
TaskTargetRunStatus	targetRunStatus()	The run status on which the started.
String	targetRunStatusAsString()	The run status on which the started.
String	taskId()	The task ID.
TaskSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The date and time the resource was updated.
String	updatedBy()	The user or system that updated this resource.

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.

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.

latestSessionActionId

public final String latestSessionActionId()

The latest session action for the task.

Returns:

The latest session action for the task.

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

Returns:

The task parameters.

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.

targetRunStatus

public final TaskTargetRunStatus targetRunStatus()

The run status on which the started.

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 on which the started.

See Also:

TaskTargetRunStatus

targetRunStatusAsString

public final String targetRunStatusAsString()

The run status on which the started.

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 on which the started.

See Also:

TaskTargetRunStatus

taskId

public final String taskId()

The task ID.

Returns:

The task ID.

updatedAt

public final Instant updatedAt()

The date and time the resource was updated.

Returns:

The date and time the resource was updated.

updatedBy

public final String updatedBy()

The user or system that updated this resource.

Returns:

The user or system that updated this resource.

toBuilder

public TaskSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TaskSummary.Builder,TaskSummary>

builder

public static TaskSummary.Builder builder()

serializableBuilderClass

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