Interface JobExecution.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<JobExecution.Builder,
,JobExecution> SdkBuilder<JobExecution.Builder,
,JobExecution> SdkPojo
- Enclosing class:
JobExecution
-
Method Summary
Modifier and TypeMethodDescriptionapproximateSecondsBeforeTimedOut
(Long approximateSecondsBeforeTimedOut) The estimated number of seconds that remain before the job execution status will be changed toTIMED_OUT
.executionNumber
(Long executionNumber) A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.forceCanceled
(Boolean forceCanceled) Will betrue
if the job execution was canceled with the optionalforce
parameter set totrue
.The unique identifier you assigned to the job when it was created.lastUpdatedAt
(Instant lastUpdatedAt) The time, in seconds since the epoch, when the job execution was last updated.The time, in seconds since the epoch, when the job execution was queued.The time, in seconds since the epoch, when the job execution started.The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).status
(JobExecutionStatus status) The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).default JobExecution.Builder
statusDetails
(Consumer<JobExecutionStatusDetails.Builder> statusDetails) A collection of name/value pairs that describe the status of the job execution.statusDetails
(JobExecutionStatusDetails statusDetails) A collection of name/value pairs that describe the status of the job execution.The ARN of the thing on which the job execution is running.versionNumber
(Long versionNumber) The version of the job execution.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
jobId
The unique identifier you assigned to the job when it was created.
- Parameters:
jobId
- The unique identifier you assigned to the job when it was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
- Parameters:
status
- The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
- Parameters:
status
- The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
forceCanceled
Will be
true
if the job execution was canceled with the optionalforce
parameter set totrue
.- Parameters:
forceCanceled
- Will betrue
if the job execution was canceled with the optionalforce
parameter set totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusDetails
A collection of name/value pairs that describe the status of the job execution.
- Parameters:
statusDetails
- A collection of name/value pairs that describe the status of the job execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusDetails
default JobExecution.Builder statusDetails(Consumer<JobExecutionStatusDetails.Builder> statusDetails) A collection of name/value pairs that describe the status of the job execution.
This is a convenience method that creates an instance of theJobExecutionStatusDetails.Builder
avoiding the need to create one manually viaJobExecutionStatusDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatusDetails(JobExecutionStatusDetails)
.- Parameters:
statusDetails
- a consumer that will call methods onJobExecutionStatusDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
thingArn
The ARN of the thing on which the job execution is running.
- Parameters:
thingArn
- The ARN of the thing on which the job execution is running.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queuedAt
The time, in seconds since the epoch, when the job execution was queued.
- Parameters:
queuedAt
- The time, in seconds since the epoch, when the job execution was queued.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedAt
The time, in seconds since the epoch, when the job execution started.
- Parameters:
startedAt
- The time, in seconds since the epoch, when the job execution started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedAt
The time, in seconds since the epoch, when the job execution was last updated.
- Parameters:
lastUpdatedAt
- The time, in seconds since the epoch, when the job execution was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionNumber
A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
- Parameters:
executionNumber
- A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionNumber
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
- Parameters:
versionNumber
- The version of the job execution. Job execution versions are incremented each time they are updated by a device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
approximateSecondsBeforeTimedOut
The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT
. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.- Parameters:
approximateSecondsBeforeTimedOut
- The estimated number of seconds that remain before the job execution status will be changed toTIMED_OUT
. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-