Class UpdateJobExecutionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateJobExecutionRequest.Builder,
UpdateJobExecutionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
Optional.final Long
Optional.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 boolean
For responses, this returns true if the service returned a value for the StatusDetails property.final Boolean
Optional.final Boolean
Optional.final String
jobId()
The unique identifier assigned to this job when it was created.static Class
<? extends UpdateJobExecutionRequest.Builder> final JobExecutionStatus
status()
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).final String
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED).Optional.final Long
Specifies the amount of time this device has to finish execution of this job.final String
The name of the thing associated with the device.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
-
jobId
The unique identifier assigned to this job when it was created.
- Returns:
- The unique identifier assigned to this job when it was created.
-
thingName
The name of the thing associated with the device.
- Returns:
- The name of the thing associated with the device.
-
status
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
If the service returns an enum value that is not available in the current SDK version,
status
will returnJobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
- See Also:
-
statusAsString
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
If the service returns an enum value that is not available in the current SDK version,
status
will returnJobExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
- See Also:
-
hasStatusDetails
public final boolean hasStatusDetails()For responses, this returns true if the service returned a value for the StatusDetails property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
statusDetails
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
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
hasStatusDetails()
method.- Returns:
- Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
-
stepTimeoutInMinutes
Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling
UpdateJobExecution
, setting the status toIN_PROGRESS
and specifying a new timeout value in this field) the job execution status will be automatically set toTIMED_OUT
. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using fieldtimeoutConfig
).- Returns:
- Specifies the amount of time this device has to finish execution of this job. If the job execution status
is not set to a terminal state before this timer expires, or before the timer is reset (by again calling
UpdateJobExecution
, setting the status toIN_PROGRESS
and specifying a new timeout value in this field) the job execution status will be automatically set toTIMED_OUT
. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using fieldtimeoutConfig
).
-
expectedVersion
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
- Returns:
- Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
-
includeJobExecutionState
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
- Returns:
- Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
-
includeJobDocument
Optional. When set to true, the response contains the job document. The default is false.
- Returns:
- Optional. When set to true, the response contains the job document. The default is false.
-
executionNumber
Optional. A number that identifies a particular job execution on a particular device.
- Returns:
- Optional. A number that identifies a particular job execution on a particular device.
-
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<UpdateJobExecutionRequest.Builder,
UpdateJobExecutionRequest> - Specified by:
toBuilder
in classIotJobsDataPlaneRequest
- 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
-