Job.Builder (AWS Java SDK :: Services :: AWS IoT 2.17.112 API)

All Superinterfaces:

Buildable, CopyableBuilder<Job.Builder,Job>, SdkBuilder<Job.Builder,Job>, SdkPojo

Enclosing class:

Job
```
public static interface Job.Builder
extends SdkPojo, CopyableBuilder<Job.Builder,Job>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Job.Builder`	`abortConfig(AbortConfig abortConfig)` Configuration for criteria to abort the job.
`default Job.Builder`	`abortConfig(Consumer<AbortConfig.Builder> abortConfig)` Configuration for criteria to abort the job.
`Job.Builder`	`comment(String comment)` If the job was updated, describes the reason for the update.
`Job.Builder`	`completedAt(Instant completedAt)` The time, in seconds since the epoch, when the job was completed.
`Job.Builder`	`createdAt(Instant createdAt)` The time, in seconds since the epoch, when the job was created.
`Job.Builder`	`description(String description)` A short text description of the job.
`Job.Builder`	`documentParameters(Map<String,String> documentParameters)` A key-value map that pairs the patterns that need to be replaced in a managed template job document schema.
`Job.Builder`	`forceCanceled(Boolean forceCanceled)` Will be `true` if the job was canceled with the optional `force` parameter set to `true`.
`Job.Builder`	`jobArn(String jobArn)` An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
`default Job.Builder`	`jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)` The configuration for the criteria to retry the job.
`Job.Builder`	`jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)` The configuration for the criteria to retry the job.
`default Job.Builder`	`jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)` Allows you to create a staged rollout of a job.
`Job.Builder`	`jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)` Allows you to create a staged rollout of a job.
`Job.Builder`	`jobId(String jobId)` The unique identifier you assigned to this job when it was created.
`default Job.Builder`	`jobProcessDetails(Consumer<JobProcessDetails.Builder> jobProcessDetails)` Details about the job process.
`Job.Builder`	`jobProcessDetails(JobProcessDetails jobProcessDetails)` Details about the job process.
`Job.Builder`	`jobTemplateArn(String jobTemplateArn)` The ARN of the job template used to create the job.
`Job.Builder`	`lastUpdatedAt(Instant lastUpdatedAt)` The time, in seconds since the epoch, when the job was last updated.
`Job.Builder`	`namespaceId(String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`default Job.Builder`	`presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)` Configuration for pre-signed S3 URLs.
`Job.Builder`	`presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)` Configuration for pre-signed S3 URLs.
`Job.Builder`	`reasonCode(String reasonCode)` If the job was updated, provides the reason code for the update.
`Job.Builder`	`status(JobStatus status)` The status of the job, one of `IN_PROGRESS`, `CANCELED`, `DELETION_IN_PROGRESS` or `COMPLETED`.
`Job.Builder`	`status(String status)` The status of the job, one of `IN_PROGRESS`, `CANCELED`, `DELETION_IN_PROGRESS` or `COMPLETED`.
`Job.Builder`	`targets(Collection<String> targets)` A list of IoT things and thing groups to which the job should be sent.
`Job.Builder`	`targets(String... targets)` A list of IoT things and thing groups to which the job should be sent.
`Job.Builder`	`targetSelection(String targetSelection)` Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).
`Job.Builder`	`targetSelection(TargetSelection targetSelection)` Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).
`default Job.Builder`	`timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)` Specifies the amount of time each device has to finish its execution of the job.
`Job.Builder`	`timeoutConfig(TimeoutConfig timeoutConfig)` Specifies the amount of time each device has to finish its execution of the job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - jobArn
```
Job.Builder jobArn(String jobArn)
```
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Parameters:
    
    jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobId
```
Job.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.
  - targetSelection
```
Job.Builder targetSelection(String targetSelection)
```
    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
    
    Parameters:
    
    targetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection, TargetSelection
  - targetSelection
```
Job.Builder targetSelection(TargetSelection targetSelection)
```
    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
    
    Parameters:
    
    targetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection, TargetSelection
  - status
```
Job.Builder status(String status)
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus, JobStatus
  - status
```
Job.Builder status(JobStatus status)
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus, JobStatus
  - forceCanceled
```
Job.Builder forceCanceled(Boolean forceCanceled)
```
    Will be true if the job was canceled with the optional force parameter set to true.
    
    Parameters:
    
    forceCanceled - Will be true if the job was canceled with the optional force parameter set to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - reasonCode
```
Job.Builder reasonCode(String reasonCode)
```
    If the job was updated, provides the reason code for the update.
    
    Parameters:
    
    reasonCode - If the job was updated, provides the reason code for the update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - comment
```
Job.Builder comment(String comment)
```
    If the job was updated, describes the reason for the update.
    
    Parameters:
    
    comment - If the job was updated, describes the reason for the update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
Job.Builder targets(Collection<String> targets)
```
    A list of IoT things and thing groups to which the job should be sent.
    
    Parameters:
    
    targets - A list of IoT things and thing groups to which the job should be sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
Job.Builder targets(String... targets)
```
    A list of IoT things and thing groups to which the job should be sent.
    
    Parameters:
    
    targets - A list of IoT things and thing groups to which the job should be sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
Job.Builder description(String description)
```
    A short text description of the job.
    
    Parameters:
    
    description - A short text description of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - presignedUrlConfig
```
Job.Builder presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration for pre-signed S3 URLs.
    
    Parameters:
    
    presignedUrlConfig - Configuration for pre-signed S3 URLs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - presignedUrlConfig
```
default Job.Builder presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)
```
    Configuration for pre-signed S3 URLs.
    This is a convenience that creates an instance of the PresignedUrlConfig.Builder avoiding the need to create one manually via PresignedUrlConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to presignedUrlConfig(PresignedUrlConfig).
    
    Parameters:
    
    presignedUrlConfig - a consumer that will call methods on PresignedUrlConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    presignedUrlConfig(PresignedUrlConfig)
  - jobExecutionsRolloutConfig
```
Job.Builder jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of a job.
    
    Parameters:
    
    jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobExecutionsRolloutConfig
```
default Job.Builder jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of a job.
    This is a convenience that creates an instance of the JobExecutionsRolloutConfig.Builder avoiding the need to create one manually via JobExecutionsRolloutConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobExecutionsRolloutConfig(JobExecutionsRolloutConfig).
    
    Parameters:
    
    jobExecutionsRolloutConfig - a consumer that will call methods on JobExecutionsRolloutConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    jobExecutionsRolloutConfig(JobExecutionsRolloutConfig)
  - abortConfig
```
Job.Builder abortConfig(AbortConfig abortConfig)
```
    Configuration for criteria to abort the job.
    
    Parameters:
    
    abortConfig - Configuration for criteria to abort the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - abortConfig
```
default Job.Builder abortConfig(Consumer<AbortConfig.Builder> abortConfig)
```
    Configuration for criteria to abort the job.
    This is a convenience that creates an instance of the AbortConfig.Builder avoiding the need to create one manually via AbortConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to abortConfig(AbortConfig).
    
    Parameters:
    
    abortConfig - a consumer that will call methods on AbortConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    abortConfig(AbortConfig)
  - createdAt
```
Job.Builder createdAt(Instant createdAt)
```
    The time, in seconds since the epoch, when the job was created.
    
    Parameters:
    
    createdAt - The time, in seconds since the epoch, when the job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastUpdatedAt
```
Job.Builder lastUpdatedAt(Instant lastUpdatedAt)
```
    The time, in seconds since the epoch, when the job was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in seconds since the epoch, when the job was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - completedAt
```
Job.Builder completedAt(Instant completedAt)
```
    The time, in seconds since the epoch, when the job was completed.
    
    Parameters:
    
    completedAt - The time, in seconds since the epoch, when the job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobProcessDetails
```
Job.Builder jobProcessDetails(JobProcessDetails jobProcessDetails)
```
    Details about the job process.
    
    Parameters:
    
    jobProcessDetails - Details about the job process.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobProcessDetails
```
default Job.Builder jobProcessDetails(Consumer<JobProcessDetails.Builder> jobProcessDetails)
```
    Details about the job process.
    This is a convenience that creates an instance of the JobProcessDetails.Builder avoiding the need to create one manually via JobProcessDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobProcessDetails(JobProcessDetails).
    
    Parameters:
    
    jobProcessDetails - a consumer that will call methods on JobProcessDetails.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    jobProcessDetails(JobProcessDetails)
  - timeoutConfig
```
Job.Builder timeoutConfig(TimeoutConfig timeoutConfig)
```
    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
    
    Parameters:
    
    timeoutConfig - Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeoutConfig
```
default Job.Builder timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)
```
    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
    This is a convenience that creates an instance of the TimeoutConfig.Builder avoiding the need to create one manually via TimeoutConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeoutConfig(TimeoutConfig).
    
    Parameters:
    
    timeoutConfig - a consumer that will call methods on TimeoutConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    timeoutConfig(TimeoutConfig)
  - namespaceId
```
Job.Builder namespaceId(String namespaceId)
```
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    The namespaceId feature is in public preview.
    
    Parameters:
    
    namespaceId - The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    The namespaceId feature is in public preview.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobTemplateArn
```
Job.Builder jobTemplateArn(String jobTemplateArn)
```
    The ARN of the job template used to create the job.
    
    Parameters:
    
    jobTemplateArn - The ARN of the job template used to create the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobExecutionsRetryConfig
```
Job.Builder jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
```
    The configuration for the criteria to retry the job.
    
    Parameters:
    
    jobExecutionsRetryConfig - The configuration for the criteria to retry the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobExecutionsRetryConfig
```
default Job.Builder jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)
```
    The configuration for the criteria to retry the job.
    This is a convenience that creates an instance of the JobExecutionsRetryConfig.Builder avoiding the need to create one manually via JobExecutionsRetryConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobExecutionsRetryConfig(JobExecutionsRetryConfig).
    
    Parameters:
    
    jobExecutionsRetryConfig - a consumer that will call methods on JobExecutionsRetryConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    jobExecutionsRetryConfig(JobExecutionsRetryConfig)
  - documentParameters
```
Job.Builder documentParameters(Map<String,String> documentParameters)
```
    A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
    
    Parameters:
    
    documentParameters - A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface Job.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

jobArn

jobId

targetSelection

targetSelection

status

status

forceCanceled

reasonCode

comment

targets

targets

description

presignedUrlConfig

presignedUrlConfig

jobExecutionsRolloutConfig

jobExecutionsRolloutConfig

abortConfig

abortConfig

createdAt

lastUpdatedAt

completedAt

jobProcessDetails

jobProcessDetails

timeoutConfig

timeoutConfig

namespaceId

jobTemplateArn

jobExecutionsRetryConfig

jobExecutionsRetryConfig

documentParameters