public static interface CreateJobRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateJobRequest.Builder |
abortConfig(AbortConfig abortConfig)
Allows you to create the criteria to abort a job.
|
default CreateJobRequest.Builder |
abortConfig(Consumer<AbortConfig.Builder> abortConfig)
Allows you to create the criteria to abort a job.
|
CreateJobRequest.Builder |
description(String description)
A short text description of the job.
|
CreateJobRequest.Builder |
document(String document)
The job document.
|
CreateJobRequest.Builder |
documentParameters(Map<String,String> documentParameters)
Parameters of an Amazon Web Services managed template that you can specify to create the job document.
|
CreateJobRequest.Builder |
documentSource(String documentSource)
An S3 link to the job document.
|
default CreateJobRequest.Builder |
jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)
Allows you to create the criteria to retry a job.
|
CreateJobRequest.Builder |
jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
Allows you to create the criteria to retry a job.
|
default CreateJobRequest.Builder |
jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
|
CreateJobRequest.Builder |
jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
|
CreateJobRequest.Builder |
jobId(String jobId)
A job identifier which must be unique for your Amazon Web Services account.
|
CreateJobRequest.Builder |
jobTemplateArn(String jobTemplateArn)
The ARN of the job template used to create the job.
|
CreateJobRequest.Builder |
namespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
CreateJobRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default CreateJobRequest.Builder |
presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
|
CreateJobRequest.Builder |
presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
|
default CreateJobRequest.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.
|
CreateJobRequest.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.
|
CreateJobRequest.Builder |
tags(Collection<Tag> tags)
Metadata which can be used to manage the job.
|
CreateJobRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Metadata which can be used to manage the job.
|
CreateJobRequest.Builder |
tags(Tag... tags)
Metadata which can be used to manage the job.
|
CreateJobRequest.Builder |
targets(Collection<String> targets)
A list of things and thing groups to which the job should be sent.
|
CreateJobRequest.Builder |
targets(String... targets)
A list of things and thing groups to which the job should be sent.
|
CreateJobRequest.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).
|
CreateJobRequest.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 CreateJobRequest.Builder |
timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)
Specifies the amount of time each device has to finish its execution of the job.
|
CreateJobRequest.Builder |
timeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of the job.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateJobRequest.Builder jobId(String jobId)
A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
jobId - A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID.
Alpha-numeric characters, "-" and "_" are valid for use here.CreateJobRequest.Builder targets(Collection<String> targets)
A list of things and thing groups to which the job should be sent.
targets - A list of things and thing groups to which the job should be sent.CreateJobRequest.Builder targets(String... targets)
A list of things and thing groups to which the job should be sent.
targets - A list of things and thing groups to which the job should be sent.CreateJobRequest.Builder documentSource(String documentSource)
An S3 link to the job document. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
documentSource - An S3 link to the job document. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
CreateJobRequest.Builder document(String document)
The job document. Required if you don't specify a value for documentSource.
document - The job document. Required if you don't specify a value for documentSource.CreateJobRequest.Builder description(String description)
A short text description of the job.
description - A short text description of the job.CreateJobRequest.Builder presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
presignedUrlConfig - Configuration information for pre-signed S3 URLs.default CreateJobRequest.Builder presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)
Configuration information 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)CreateJobRequest.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 thing when the thing 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 thing when the
thing 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,
TargetSelectionCreateJobRequest.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 thing when the thing 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 thing when the
thing 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,
TargetSelectionCreateJobRequest.Builder jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.default CreateJobRequest.Builder jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the 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)CreateJobRequest.Builder abortConfig(AbortConfig abortConfig)
Allows you to create the criteria to abort a job.
abortConfig - Allows you to create the criteria to abort a job.default CreateJobRequest.Builder abortConfig(Consumer<AbortConfig.Builder> abortConfig)
Allows you to create the criteria to abort a 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)CreateJobRequest.Builder timeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of the job. The 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 time 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. The 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 time expires, it will be automatically set to
TIMED_OUT.default CreateJobRequest.Builder timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)
Specifies the amount of time each device has to finish its execution of the job. The 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 time 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)CreateJobRequest.Builder tags(Collection<Tag> tags)
Metadata which can be used to manage the job.
tags - Metadata which can be used to manage the job.CreateJobRequest.Builder tags(Tag... tags)
Metadata which can be used to manage the job.
tags - Metadata which can be used to manage the job.CreateJobRequest.Builder tags(Consumer<Tag.Builder>... tags)
Metadata which can be used to manage the job.
This is a convenience method that creates an instance of theTag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) CreateJobRequest.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.
CreateJobRequest.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.CreateJobRequest.Builder jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
Allows you to create the criteria to retry a job.
jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.default CreateJobRequest.Builder jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)
Allows you to create the criteria to retry a 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)CreateJobRequest.Builder documentParameters(Map<String,String> documentParameters)
Parameters of an Amazon Web Services managed template that you can specify to create the job document.
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 - Parameters of an Amazon Web Services managed template that you can specify to create the job
document.
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.
CreateJobRequest.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 CreateJobRequest.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)CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.