| Package | Description |
|---|---|
| com.amazonaws.services.iot.model |
| Modifier and Type | Method and Description |
|---|---|
Job |
Job.addDocumentParametersEntry(String key,
String value)
Add a single DocumentParameters entry
|
Job |
Job.clearDocumentParametersEntries()
Removes all the entries added into DocumentParameters.
|
Job |
Job.clone() |
Job |
DescribeJobResult.getJob()
Information about the job.
|
Job |
Job.withAbortConfig(AbortConfig abortConfig)
Configuration for criteria to abort the job.
|
Job |
Job.withComment(String comment)
If the job was updated, describes the reason for the update.
|
Job |
Job.withCompletedAt(Date completedAt)
The time, in seconds since the epoch, when the job was completed.
|
Job |
Job.withCreatedAt(Date createdAt)
The time, in seconds since the epoch, when the job was created.
|
Job |
Job.withDescription(String description)
A short text description of the job.
|
Job |
Job.withDestinationPackageVersions(Collection<String> destinationPackageVersions)
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully
completes.
|
Job |
Job.withDestinationPackageVersions(String... destinationPackageVersions)
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully
completes.
|
Job |
Job.withDocumentParameters(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 |
Job.withForceCanceled(Boolean forceCanceled)
Will be
true if the job was canceled with the optional force parameter set to
true. |
Job |
Job.withIsConcurrent(Boolean isConcurrent)
Indicates whether a job is concurrent.
|
Job |
Job.withJobArn(String jobArn)
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
|
Job |
Job.withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
The configuration for the criteria to retry the job.
|
Job |
Job.withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
|
Job |
Job.withJobId(String jobId)
The unique identifier you assigned to this job when it was created.
|
Job |
Job.withJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
|
Job |
Job.withJobTemplateArn(String jobTemplateArn)
The ARN of the job template used to create the job.
|
Job |
Job.withLastUpdatedAt(Date lastUpdatedAt)
The time, in seconds since the epoch, when the job was last updated.
|
Job |
Job.withNamespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
Job |
Job.withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
|
Job |
Job.withReasonCode(String reasonCode)
If the job was updated, provides the reason code for the update.
|
Job |
Job.withScheduledJobRollouts(Collection<ScheduledJobRollout> scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
|
Job |
Job.withScheduledJobRollouts(ScheduledJobRollout... scheduledJobRollouts)
Displays the next seven maintenance window occurrences and their start times.
|
Job |
Job.withSchedulingConfig(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 |
Job.withStatus(JobStatus status)
The status of the job, one of
IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS
or COMPLETED. |
Job |
Job.withStatus(String status)
The status of the job, one of
IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS
or COMPLETED. |
Job |
Job.withTargets(Collection<String> targets)
A list of IoT things and thing groups to which the job should be sent.
|
Job |
Job.withTargets(String... targets)
A list of IoT things and thing groups to which the job should be sent.
|
Job |
Job.withTargetSelection(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 |
Job.withTargetSelection(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).
|
Job |
Job.withTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of the job.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DescribeJobResult.setJob(Job job)
Information about the job.
|
DescribeJobResult |
DescribeJobResult.withJob(Job job)
Information about the job.
|
Copyright © 2023. All rights reserved.