Package software.amazon.awssdk.services.iotjobsdataplane.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 Details

    • jobId

      JobExecution.Builder jobId(String jobId)

      The unique identifier you assigned to this job when it was created.

      Parameters:
      jobId - The unique identifier you assigned to this job when it was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thingName

      JobExecution.Builder thingName(String thingName)

      The name of the thing that is executing the job.

      Parameters:
      thingName - The name of the thing that is executing the job.
      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. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

      Parameters:
      status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      JobExecution.Builder status(JobExecutionStatus status)

      The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

      Parameters:
      status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusDetails

      JobExecution.Builder statusDetails(Map<String,String> 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.

    • queuedAt

      JobExecution.Builder queuedAt(Long queuedAt)

      The time, in milliseconds since the epoch, when the job execution was enqueued.

      Parameters:
      queuedAt - The time, in milliseconds since the epoch, when the job execution was enqueued.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      JobExecution.Builder startedAt(Long startedAt)

      The time, in milliseconds since the epoch, when the job execution was started.

      Parameters:
      startedAt - The time, in milliseconds since the epoch, when the job execution was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      JobExecution.Builder lastUpdatedAt(Long lastUpdatedAt)

      The time, in milliseconds since the epoch, when the job execution was last updated.

      Parameters:
      lastUpdatedAt - The time, in milliseconds 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.

    • approximateSecondsBeforeTimedOut

      JobExecution.Builder approximateSecondsBeforeTimedOut(Long approximateSecondsBeforeTimedOut)

      The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

      Parameters:
      approximateSecondsBeforeTimedOut - The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
      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.

    • executionNumber

      JobExecution.Builder executionNumber(Long executionNumber)

      A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

      Parameters:
      executionNumber - A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobDocument

      JobExecution.Builder jobDocument(String jobDocument)

      The content of the job document.

      Parameters:
      jobDocument - The content of the job document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.