Package software.amazon.awssdk.services.iotjobsdataplane.model

Interface UpdateJobExecutionRequest.Builder

    • Method Detail

      • jobId

        UpdateJobExecutionRequest.Builder jobId​(String jobId)

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

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

      • thingName

        UpdateJobExecutionRequest.Builder thingName​(String thingName)

        The name of the thing associated with the device.

        Parameters:
        thingName - The name of the thing associated with the device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        UpdateJobExecutionRequest.Builder status​(String status)

        The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

        Parameters:
        status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobExecutionStatus, JobExecutionStatus

      • status

        UpdateJobExecutionRequest.Builder status​(JobExecutionStatus status)

        The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

        Parameters:
        status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobExecutionStatus, JobExecutionStatus

      • statusDetails

        UpdateJobExecutionRequest.Builder statusDetails​(Map<String,​String> statusDetails)

        Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

        Parameters:
        statusDetails - Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stepTimeoutInMinutes

        UpdateJobExecutionRequest.Builder stepTimeoutInMinutes​(Long 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 to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_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 field timeoutConfig).

        Parameters:
        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 to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_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 field timeoutConfig).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expectedVersion

        UpdateJobExecutionRequest.Builder expectedVersion​(Long 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.)

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • includeJobExecutionState

        UpdateJobExecutionRequest.Builder includeJobExecutionState​(Boolean includeJobExecutionState)

        Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

        Parameters:
        includeJobExecutionState - Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeJobDocument

        UpdateJobExecutionRequest.Builder includeJobDocument​(Boolean includeJobDocument)

        Optional. When set to true, the response contains the job document. The default is false.

        Parameters:
        includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionNumber

        UpdateJobExecutionRequest.Builder executionNumber​(Long executionNumber)

        Optional. A number that identifies a particular job execution on a particular device.

        Parameters:
        executionNumber - Optional. A number that identifies a particular job execution on a particular device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.