Package software.amazon.awssdk.services.iot.model

Interface CancelJobRequest.Builder

    • Method Detail

      • jobId

        CancelJobRequest.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.

      • reasonCode

        CancelJobRequest.Builder reasonCode​(String reasonCode)

        (Optional)A reason code string that explains why the job was canceled.

        Parameters:
        reasonCode - (Optional)A reason code string that explains why the job was canceled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • comment

        CancelJobRequest.Builder comment​(String comment)

        An optional comment string describing why the job was canceled.

        Parameters:
        comment - An optional comment string describing why the job was canceled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • force

        CancelJobRequest.Builder force​(Boolean force)

        (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

        Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

        Parameters:
        force - (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false .

        Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

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