software.amazon.awssdk.services.iot.model

Interface JobExecution.Builder

All Superinterfaces:

Buildable, CopyableBuilder<JobExecution.Builder,JobExecution>, SdkBuilder<JobExecution.Builder,JobExecution>, SdkPojo

Enclosing class:

JobExecution

public static interface JobExecution.Builder
extends SdkPojo, CopyableBuilder<JobExecution.Builder,JobExecution>

Method Summary

Modifier and Type	Method and Description
JobExecution.Builder	approximateSecondsBeforeTimedOut(Long approximateSecondsBeforeTimedOut) The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
JobExecution.Builder	executionNumber(Long executionNumber) A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
JobExecution.Builder	forceCanceled(Boolean forceCanceled) Will be true if the job execution was canceled with the optional force parameter set to true.
JobExecution.Builder	jobId(String jobId) The unique identifier you assigned to the job when it was created.
JobExecution.Builder	lastUpdatedAt(Instant lastUpdatedAt) The time, in seconds since the epoch, when the job execution was last updated.
JobExecution.Builder	queuedAt(Instant queuedAt) The time, in seconds since the epoch, when the job execution was queued.
JobExecution.Builder	startedAt(Instant startedAt) The time, in seconds since the epoch, when the job execution started.
JobExecution.Builder	status(JobExecutionStatus status) The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
JobExecution.Builder	status(String 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.
JobExecution.Builder	statusDetails(JobExecutionStatusDetails statusDetails) A collection of name/value pairs that describe the status of the job execution.
JobExecution.Builder	thingArn(String thingArn) The ARN of the thing on which the job execution is running.
JobExecution.Builder	versionNumber(Long versionNumber) The version of the job execution.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

jobId

JobExecution.Builder jobId(String 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

JobExecution.Builder status(String 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:

JobExecutionStatus, JobExecutionStatus

status

JobExecution.Builder status(JobExecutionStatus 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:

JobExecutionStatus, JobExecutionStatus

forceCanceled

JobExecution.Builder forceCanceled(Boolean forceCanceled)

Will be true if the job execution was canceled with the optional force parameter set to true.

Parameters:

forceCanceled - Will be true if the job execution was canceled with the optional force parameter set to true.

Returns:

Returns a reference to this object so that method calls can be chained together.

statusDetails

JobExecution.Builder statusDetails(JobExecutionStatusDetails 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 that creates an instance of the JobExecutionStatusDetails.Builder avoiding the need to create one manually via JobExecutionStatusDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusDetails(JobExecutionStatusDetails).

Parameters:

statusDetails - a consumer that will call methods on JobExecutionStatusDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

statusDetails(JobExecutionStatusDetails)

thingArn

JobExecution.Builder thingArn(String 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

JobExecution.Builder queuedAt(Instant 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

JobExecution.Builder startedAt(Instant 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

JobExecution.Builder lastUpdatedAt(Instant 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

JobExecution.Builder executionNumber(Long 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

JobExecution.Builder versionNumber(Long 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

JobExecution.Builder approximateSecondsBeforeTimedOut(Long 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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.