Class UpdateJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateJobRequest.Builder,
UpdateJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateJobRequest.Builder
builder()
final String
The unique token which the server uses to recognize retries of the same request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
farmId()
The farm ID of the job to update.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
jobId()
The job ID to update.final UpdateJobLifecycleStatus
The status of a job in its lifecycle.final String
The status of a job in its lifecycle.final Integer
The number of task failures before the job stops running and is marked asFAILED
.final Integer
The maximum number of retries for a job.final Integer
priority()
The job priority to update.final String
queueId()
The queue ID of the job to update.static Class
<? extends UpdateJobRequest.Builder> final JobTargetTaskRunStatus
The task status to update the job's tasks to.final String
The task status to update the job's tasks to.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The farm ID of the job to update.
- Returns:
- The farm ID of the job to update.
-
jobId
The job ID to update.
- Returns:
- The job ID to update.
-
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 returnUpdateJobLifecycleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleStatusAsString()
.- Returns:
- The status of a job in its lifecycle.
- See Also:
-
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 returnUpdateJobLifecycleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleStatusAsString()
.- Returns:
- The status of a job in its lifecycle.
- See Also:
-
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
The maximum number of retries for a job.
- Returns:
- The maximum number of retries for a job.
-
priority
The job priority to update.
- Returns:
- The job priority to update.
-
queueId
The queue ID of the job to update.
- Returns:
- The queue ID of the job to update.
-
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 returnJobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTaskRunStatusAsString()
.- Returns:
- The task status to update the job's tasks to.
- See Also:
-
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 returnJobTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetTaskRunStatusAsString()
.- Returns:
- The task status to update the job's tasks to.
- See Also:
-
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 interfaceToCopyableBuilder<UpdateJobRequest.Builder,
UpdateJobRequest> - Specified by:
toBuilder
in classDeadlineRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-