Job (AWS Java SDK :: Services :: AWS IoT 2.9.7 API)

java.lang.Object
- software.amazon.awssdk.services.iot.model.Job

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>

@Generated(value="software.amazon.awssdk:codegen")
public final class Job
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>

The Job object contains details about a job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Job.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Job.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbortConfig`	`abortConfig()` Configuration for criteria to abort the job.
`static Job.Builder`	`builder()`
`String`	`comment()` If the job was updated, describes the reason for the update.
`Instant`	`completedAt()` The time, in seconds since the epoch, when the job was completed.
`Instant`	`createdAt()` The time, in seconds since the epoch, when the job was created.
`String`	`description()` A short text description of the job.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`forceCanceled()` Will be `true` if the job was canceled with the optional `force` parameter set to `true`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`jobArn()` An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
`JobExecutionsRolloutConfig`	`jobExecutionsRolloutConfig()` Allows you to create a staged rollout of a job.
`String`	`jobId()` The unique identifier you assigned to this job when it was created.
`JobProcessDetails`	`jobProcessDetails()` Details about the job process.
`Instant`	`lastUpdatedAt()` The time, in seconds since the epoch, when the job was last updated.
`PresignedUrlConfig`	`presignedUrlConfig()` Configuration for pre-signed S3 URLs.
`String`	`reasonCode()` If the job was updated, provides the reason code for the update.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Job.Builder>`	`serializableBuilderClass()`
`JobStatus`	`status()` The status of the job, one of `IN_PROGRESS`, `CANCELED`, `DELETION_IN_PROGRESS` or `COMPLETED`.
`String`	`statusAsString()` The status of the job, one of `IN_PROGRESS`, `CANCELED`, `DELETION_IN_PROGRESS` or `COMPLETED`.
`List<String>`	`targets()` A list of IoT things and thing groups to which the job should be sent.
`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).
`String`	`targetSelectionAsString()` 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).
`TimeoutConfig`	`timeoutConfig()` Specifies the amount of time each device has to finish its execution of the job.
`Job.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - jobArn
```
public String jobArn()
```
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Returns:
    
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
  - jobId
```
public String jobId()
```
    The unique identifier you assigned to this job when it was created.
    
    Returns:
    
    The unique identifier you assigned to this job when it was created.
  - targetSelection
```
public 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.
    
    If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    TargetSelection
  - targetSelectionAsString
```
public String targetSelectionAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    TargetSelection
  - status
```
public JobStatus status()
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    See Also:
    
    JobStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    See Also:
    
    JobStatus
  - forceCanceled
```
public Boolean forceCanceled()
```
    Will be true if the job was canceled with the optional force parameter set to true.
    
    Returns:
    
    Will be true if the job was canceled with the optional force parameter set to true.
  - reasonCode
```
public String reasonCode()
```
    If the job was updated, provides the reason code for the update.
    
    Returns:
    
    If the job was updated, provides the reason code for the update.
  - comment
```
public String comment()
```
    If the job was updated, describes the reason for the update.
    
    Returns:
    
    If the job was updated, describes the reason for the update.
  - targets
```
public List<String> targets()
```
    A list of IoT things and thing groups to which the job should be sent.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of IoT things and thing groups to which the job should be sent.
  - description
```
public String description()
```
    A short text description of the job.
    
    Returns:
    
    A short text description of the job.
  - presignedUrlConfig
```
public PresignedUrlConfig presignedUrlConfig()
```
    Configuration for pre-signed S3 URLs.
    
    Returns:
    
    Configuration for pre-signed S3 URLs.
  - jobExecutionsRolloutConfig
```
public JobExecutionsRolloutConfig jobExecutionsRolloutConfig()
```
    Allows you to create a staged rollout of a job.
    
    Returns:
    
    Allows you to create a staged rollout of a job.
  - abortConfig
```
public AbortConfig abortConfig()
```
    Configuration for criteria to abort the job.
    
    Returns:
    
    Configuration for criteria to abort the job.
  - createdAt
```
public Instant createdAt()
```
    The time, in seconds since the epoch, when the job was created.
    
    Returns:
    
    The time, in seconds since the epoch, when the job was created.
  - lastUpdatedAt
```
public Instant lastUpdatedAt()
```
    The time, in seconds since the epoch, when the job was last updated.
    
    Returns:
    
    The time, in seconds since the epoch, when the job was last updated.
  - completedAt
```
public Instant completedAt()
```
    The time, in seconds since the epoch, when the job was completed.
    
    Returns:
    
    The time, in seconds since the epoch, when the job was completed.
  - jobProcessDetails
```
public JobProcessDetails jobProcessDetails()
```
    Details about the job process.
    
    Returns:
    
    Details about the job process.
  - timeoutConfig
```
public 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.
    
    Returns:
    
    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.
  - toBuilder
```
public Job.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Job.Builder,Job>
  - builder
```
public static Job.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Job.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Job

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

jobArn

jobId

targetSelection

targetSelectionAsString

status

statusAsString

forceCanceled

reasonCode

comment

targets

description

presignedUrlConfig

jobExecutionsRolloutConfig

abortConfig

createdAt

lastUpdatedAt

completedAt

jobProcessDetails

timeoutConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields