public static interface Job.Builder extends SdkPojo, CopyableBuilder<Job.Builder,Job>
| 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 |
isConcurrent(Boolean isConcurrent)
Indicates whether a job is concurrent.
|
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 |
scheduledJobRollouts(Collection<ScheduledJobRollout> scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
|
Job.Builder |
scheduledJobRollouts(Consumer<ScheduledJobRollout.Builder>... scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
|
Job.Builder |
scheduledJobRollouts(ScheduledJobRollout... scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
|
default Job.Builder |
schedulingConfig(Consumer<SchedulingConfig.Builder> schedulingConfig)
The configuration that allows you to schedule a job for a future date and time in addition to specifying the
end behavior for each job execution.
|
Job.Builder |
schedulingConfig(SchedulingConfig schedulingConfig)
The configuration that allows you to schedule a job for a future date and time in addition to specifying the
end behavior for each job execution.
|
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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildJob.Builder jobArn(String jobArn)
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".Job.Builder jobId(String jobId)
The unique identifier you assigned to this job when it was created.
jobId - The unique identifier you assigned to this job when it was created.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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
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. We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
TargetSelection,
TargetSelectionJob.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.
We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
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. We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
TargetSelection,
TargetSelectionJob.Builder status(String status)
The status of the job, one of IN_PROGRESS, CANCELED,
DELETION_IN_PROGRESS or COMPLETED.
Job.Builder status(JobStatus status)
The status of the job, one of IN_PROGRESS, CANCELED,
DELETION_IN_PROGRESS or COMPLETED.
Job.Builder forceCanceled(Boolean forceCanceled)
Will be true if the job was canceled with the optional force parameter set to
true.
forceCanceled - Will be true if the job was canceled with the optional force parameter set
to true.Job.Builder reasonCode(String reasonCode)
If the job was updated, provides the reason code for the update.
reasonCode - If the job was updated, provides the reason code for the update.Job.Builder comment(String comment)
If the job was updated, describes the reason for the update.
comment - If the job was updated, describes the reason for the update.Job.Builder targets(Collection<String> targets)
A list of IoT things and thing groups to which the job should be sent.
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.
targets - A list of IoT things and thing groups to which the job should be sent.Job.Builder description(String description)
A short text description of the job.
description - A short text description of the job.Job.Builder presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
presignedUrlConfig - Configuration for pre-signed S3 URLs.default Job.Builder presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)
Configuration for pre-signed S3 URLs.
This is a convenience method that creates an instance of thePresignedUrlConfig.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).
presignedUrlConfig - a consumer that will call methods on PresignedUrlConfig.BuilderpresignedUrlConfig(PresignedUrlConfig)Job.Builder jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.default Job.Builder jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
This is a convenience method that creates an instance of theJobExecutionsRolloutConfig.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).
jobExecutionsRolloutConfig - a consumer that will call methods on JobExecutionsRolloutConfig.BuilderjobExecutionsRolloutConfig(JobExecutionsRolloutConfig)Job.Builder abortConfig(AbortConfig abortConfig)
Configuration for criteria to abort the job.
abortConfig - Configuration for criteria to abort the job.default Job.Builder abortConfig(Consumer<AbortConfig.Builder> abortConfig)
Configuration for criteria to abort the job.
This is a convenience method that creates an instance of theAbortConfig.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).
abortConfig - a consumer that will call methods on AbortConfig.BuilderabortConfig(AbortConfig)Job.Builder createdAt(Instant createdAt)
The time, in seconds since the epoch, when the job was created.
createdAt - The time, in seconds since the epoch, when the job was created.Job.Builder lastUpdatedAt(Instant lastUpdatedAt)
The time, in seconds since the epoch, when the job was last updated.
lastUpdatedAt - The time, in seconds since the epoch, when the job was last updated.Job.Builder completedAt(Instant completedAt)
The time, in seconds since the epoch, when the job was completed.
completedAt - The time, in seconds since the epoch, when the job was completed.Job.Builder jobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
jobProcessDetails - Details about the job process.default Job.Builder jobProcessDetails(Consumer<JobProcessDetails.Builder> jobProcessDetails)
Details about the job process.
This is a convenience method that creates an instance of theJobProcessDetails.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).
jobProcessDetails - a consumer that will call methods on JobProcessDetails.BuilderjobProcessDetails(JobProcessDetails)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.
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.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.
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).
timeoutConfig - a consumer that will call methods on TimeoutConfig.BuildertimeoutConfig(TimeoutConfig)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.
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.
Job.Builder jobTemplateArn(String jobTemplateArn)
The ARN of the job template used to create the job.
jobTemplateArn - The ARN of the job template used to create the job.Job.Builder jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
The configuration for the criteria to retry the job.
jobExecutionsRetryConfig - The configuration for the criteria to retry the job.default Job.Builder jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)
The configuration for the criteria to retry the job.
This is a convenience method that creates an instance of theJobExecutionsRetryConfig.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).
jobExecutionsRetryConfig - a consumer that will call methods on JobExecutionsRetryConfig.BuilderjobExecutionsRetryConfig(JobExecutionsRetryConfig)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.
documentParameters can only be used when creating jobs from Amazon Web Services managed
templates. This parameter can't be used with custom job templates or to create jobs from them.
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.
documentParameters can only be used when creating jobs from Amazon Web Services managed
templates. This parameter can't be used with custom job templates or to create jobs from them.
Job.Builder isConcurrent(Boolean isConcurrent)
Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
isConcurrent - Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or
canceling previously created executions, otherwise false.Job.Builder schedulingConfig(SchedulingConfig schedulingConfig)
The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
schedulingConfig - The configuration that allows you to schedule a job for a future date and time in addition to
specifying the end behavior for each job execution.default Job.Builder schedulingConfig(Consumer<SchedulingConfig.Builder> schedulingConfig)
The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
This is a convenience method that creates an instance of theSchedulingConfig.Builder avoiding the
need to create one manually via SchedulingConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to schedulingConfig(SchedulingConfig).
schedulingConfig - a consumer that will call methods on SchedulingConfig.BuilderschedulingConfig(SchedulingConfig)Job.Builder scheduledJobRollouts(Collection<ScheduledJobRollout> scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
scheduledJobRollouts - Displays the next seven maintenance window occurrences and their start times.Job.Builder scheduledJobRollouts(ScheduledJobRollout... scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
scheduledJobRollouts - Displays the next seven maintenance window occurrences and their start times.Job.Builder scheduledJobRollouts(Consumer<ScheduledJobRollout.Builder>... scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
This is a convenience method that creates an instance of theScheduledJobRollout.Builder avoiding the need to create one
manually via ScheduledJobRollout.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #scheduledJobRollouts(List.
scheduledJobRollouts - a consumer that will call methods on
ScheduledJobRollout.Builder#scheduledJobRollouts(java.util.Collection) Copyright © 2023. All rights reserved.