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 Summary
Modifier and TypeMethodDescriptionexecutionNumber
(Long executionNumber) Optional.includeJobDocument
(Boolean includeJobDocument) Optional.The unique identifier assigned to this job when it was created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The thing name associated with the device the job execution is running on.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iotjobsdataplane.model.IotJobsDataPlaneRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-