CreateJobRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iot.model.IotRequest
    - - software.amazon.awssdk.services.iot.model.CreateJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateJobRequest
extends IotRequest
implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateJobRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbortConfig`	`abortConfig()` Allows you to create criteria to abort a job.
`static CreateJobRequest.Builder`	`builder()`
`String`	`description()` A short text description of the job.
`String`	`document()` The job document.
`String`	`documentSource()` An S3 link to the job document.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`JobExecutionsRolloutConfig`	`jobExecutionsRolloutConfig()` Allows you to create a staged rollout of the job.
`String`	`jobId()` A job identifier which must be unique for your AWS account.
`PresignedUrlConfig`	`presignedUrlConfig()` Configuration information for pre-signed S3 URLs.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateJobRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Metadata which can be used to manage the job.
`List<String>`	`targets()` A list of 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.
`CreateJobRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - jobId
```
public String jobId()
```
    A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
    
    Returns:
    
    A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
  - targets
```
public List<String> targets()
```
    A list of 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 things and thing groups to which the job should be sent.
  - documentSource
```
public String documentSource()
```
    An S3 link to the job document.
    
    Returns:
    
    An S3 link to the job document.
  - document
```
public String document()
```
    The job 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.
    
    Returns:
    
    The job 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.
  - description
```
public String description()
```
    A short text description of the job.
    
    Returns:
    
    A short text description of the job.
  - presignedUrlConfig
```
public PresignedUrlConfig presignedUrlConfig()
```
    Configuration information for pre-signed S3 URLs.
    
    Returns:
    
    Configuration information for pre-signed S3 URLs.
  - 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 thing when the thing 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 thing when the thing 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 thing when the thing 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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
    
    See Also:
    
    TargetSelection
  - jobExecutionsRolloutConfig
```
public JobExecutionsRolloutConfig jobExecutionsRolloutConfig()
```
    Allows you to create a staged rollout of the job.
    
    Returns:
    
    Allows you to create a staged rollout of the job.
  - abortConfig
```
public AbortConfig abortConfig()
```
    Allows you to create criteria to abort a job.
    
    Returns:
    
    Allows you to create criteria to abort a job.
  - timeoutConfig
```
public 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.
    
    Returns:
    
    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 .
  - tags
```
public List<Tag> tags()
```
    Metadata which can be used to manage the job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Metadata which can be used to manage the job.
  - toBuilder
```
public CreateJobRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

jobId

targets

documentSource

document

description

presignedUrlConfig

targetSelection

targetSelectionAsString

jobExecutionsRolloutConfig

abortConfig

timeoutConfig

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields