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

Class UpdateJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.deadline.model.DeadlineRequest

software.amazon.awssdk.services.deadline.model.UpdateJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateJobRequest
extends DeadlineRequest
implements ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateJobRequest.Builder	builder()
String	clientToken()	The unique token which the server uses to recognize retries of the same request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	farmId()	The farm ID of the job to update.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The job ID to update.
UpdateJobLifecycleStatus	lifecycleStatus()	The status of a job in its lifecycle.
String	lifecycleStatusAsString()	The status of a job in its lifecycle.
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.
Integer	priority()	The job priority to update.
String	queueId()	The queue ID of the job to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateJobRequest.Builder>	serializableBuilderClass()
JobTargetTaskRunStatus	targetTaskRunStatus()	The task status to update the job's tasks to.
String	targetTaskRunStatusAsString()	The task status to update the job's tasks to.
UpdateJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

The unique token which the server uses to recognize retries of the same request.

Returns:

The unique token which the server uses to recognize retries of the same request.

farmId

public final String farmId()

The farm ID of the job to update.

Returns:

The farm ID of the job to update.

jobId

public final String jobId()

The job ID to update.

Returns:

The job ID to update.

lifecycleStatus

public final UpdateJobLifecycleStatus lifecycleStatus()

The status of a job in its lifecycle.

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

Returns:

The status of a job in its lifecycle.

See Also:

UpdateJobLifecycleStatus

lifecycleStatusAsString

public final String lifecycleStatusAsString()

The status of a job in its lifecycle.

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

Returns:

The status of a job in its lifecycle.

See Also:

UpdateJobLifecycleStatus

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.

priority

public final Integer priority()

The job priority to update.

Returns:

The job priority to update.

queueId

public final String queueId()

The queue ID of the job to update.

Returns:

The queue ID of the job to update.

targetTaskRunStatus

public final JobTargetTaskRunStatus targetTaskRunStatus()

The task status to update the job's tasks to.

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 update the job's tasks to.

See Also:

JobTargetTaskRunStatus

targetTaskRunStatusAsString

public final String targetTaskRunStatusAsString()

The task status to update the job's tasks to.

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 update the job's tasks to.

See Also:

JobTargetTaskRunStatus

toBuilder

public UpdateJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

Specified by:

toBuilder in class DeadlineRequest

builder

public static UpdateJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo