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

Interface DescribeJobExecutionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeJobExecutionRequest.Builder,DescribeJobExecutionRequest>, IotJobsDataPlaneRequest.Builder, SdkBuilder<DescribeJobExecutionRequest.Builder,DescribeJobExecutionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeJobExecutionRequest
public static interface DescribeJobExecutionRequest.Builder extends IotJobsDataPlaneRequest.Builder, SdkPojo, CopyableBuilder<DescribeJobExecutionRequest.Builder,DescribeJobExecutionRequest>

  • Method Details

    • jobId

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

      DescribeJobExecutionRequest.Builder thingName(String thingName)

      The thing name associated with the device the job execution is running on.

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

    • includeJobDocument

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

      DescribeJobExecutionRequest.Builder executionNumber(Long executionNumber)

      Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

      Parameters:
      executionNumber - Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeJobExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeJobExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.