CreateJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.CreateJobRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateJobRequest()

Constructors
Constructor and Description
`CreateJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateJobRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AbortConfig`	`getAbortConfig()` Allows you to create criteria to abort a job.
`String`	`getDescription()` A short text description of the job.
`String`	`getDocument()` The job document.
`String`	`getDocumentSource()` An S3 link to the job document.
`JobExecutionsRolloutConfig`	`getJobExecutionsRolloutConfig()` Allows you to create a staged rollout of the job.
`String`	`getJobId()` A job identifier which must be unique for your AWS account.
`PresignedUrlConfig`	`getPresignedUrlConfig()` Configuration information for pre-signed S3 URLs.
`List<Tag>`	`getTags()` Metadata which can be used to manage the job.
`List<String>`	`getTargets()` A list of things and thing groups to which the job should be sent.
`String`	`getTargetSelection()` 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`	`getTimeoutConfig()` Specifies the amount of time each device has to finish its execution of the job.
`int`	`hashCode()`
`void`	`setAbortConfig(AbortConfig abortConfig)` Allows you to create criteria to abort a job.
`void`	`setDescription(String description)` A short text description of the job.
`void`	`setDocument(String document)` The job document.
`void`	`setDocumentSource(String documentSource)` An S3 link to the job document.
`void`	`setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)` Allows you to create a staged rollout of the job.
`void`	`setJobId(String jobId)` A job identifier which must be unique for your AWS account.
`void`	`setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)` Configuration information for pre-signed S3 URLs.
`void`	`setTags(Collection<Tag> tags)` Metadata which can be used to manage the job.
`void`	`setTargets(Collection<String> targets)` A list of things and thing groups to which the job should be sent.
`void`	`setTargetSelection(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).
`void`	`setTimeoutConfig(TimeoutConfig timeoutConfig)` Specifies the amount of time each device has to finish its execution of the job.
`String`	`toString()` Returns a string representation of this object.
`CreateJobRequest`	`withAbortConfig(AbortConfig abortConfig)` Allows you to create criteria to abort a job.
`CreateJobRequest`	`withDescription(String description)` A short text description of the job.
`CreateJobRequest`	`withDocument(String document)` The job document.
`CreateJobRequest`	`withDocumentSource(String documentSource)` An S3 link to the job document.
`CreateJobRequest`	`withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)` Allows you to create a staged rollout of the job.
`CreateJobRequest`	`withJobId(String jobId)` A job identifier which must be unique for your AWS account.
`CreateJobRequest`	`withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)` Configuration information for pre-signed S3 URLs.
`CreateJobRequest`	`withTags(Collection<Tag> tags)` Metadata which can be used to manage the job.
`CreateJobRequest`	`withTags(Tag... tags)` Metadata which can be used to manage the job.
`CreateJobRequest`	`withTargets(Collection<String> targets)` A list of things and thing groups to which the job should be sent.
`CreateJobRequest`	`withTargets(String... targets)` A list of things and thing groups to which the job should be sent.
`CreateJobRequest`	`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).
`CreateJobRequest`	`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).
`CreateJobRequest`	`withTimeoutConfig(TimeoutConfig timeoutConfig)` Specifies the amount of time each device has to finish its execution of the job.

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

- Constructor Detail
  - CreateJobRequest
```
public CreateJobRequest()
```
- Method Detail
  - setJobId
```
public void setJobId(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.
    
    Parameters:
    
    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.
  - getJobId
```
public String getJobId()
```
    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.
  - withJobId
```
public CreateJobRequest withJobId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargets
```
public List<String> getTargets()
```
    A list of things and thing groups to which the job should be sent.
    
    Returns:
    
    A list of things and thing groups to which the job should be sent.
  - setTargets
```
public void setTargets(Collection<String> targets)
```
    A list of things and thing groups to which the job should be sent.
    
    Parameters:
    
    targets - A list of things and thing groups to which the job should be sent.
  - withTargets
```
public CreateJobRequest withTargets(String... targets)
```
    A list of things and thing groups to which the job should be sent.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targets - A list of things and thing groups to which the job should be sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public CreateJobRequest withTargets(Collection<String> targets)
```
    A list of things and thing groups to which the job should be sent.
    
    Parameters:
    
    targets - A list of things and thing groups to which the job should be sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentSource
```
public void setDocumentSource(String documentSource)
```
    An S3 link to the job document.
    
    Parameters:
    
    documentSource - An S3 link to the job document.
  - getDocumentSource
```
public String getDocumentSource()
```
    An S3 link to the job document.
    
    Returns:
    
    An S3 link to the job document.
  - withDocumentSource
```
public CreateJobRequest withDocumentSource(String documentSource)
```
    An S3 link to the job document.
    
    Parameters:
    
    documentSource - An S3 link to the job document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocument
```
public void setDocument(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.
    
    Parameters:
    
    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.
  - getDocument
```
public String getDocument()
```
    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.
  - withDocument
```
public CreateJobRequest withDocument(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A short text description of the job.
    
    Parameters:
    
    description - A short text description of the job.
  - getDescription
```
public String getDescription()
```
    A short text description of the job.
    
    Returns:
    
    A short text description of the job.
  - withDescription
```
public CreateJobRequest withDescription(String description)
```
    A short text description of the job.
    
    Parameters:
    
    description - A short text description of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPresignedUrlConfig
```
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration information for pre-signed S3 URLs.
    
    Parameters:
    
    presignedUrlConfig - Configuration information for pre-signed S3 URLs.
  - getPresignedUrlConfig
```
public PresignedUrlConfig getPresignedUrlConfig()
```
    Configuration information for pre-signed S3 URLs.
    
    Returns:
    
    Configuration information for pre-signed S3 URLs.
  - withPresignedUrlConfig
```
public CreateJobRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration information for pre-signed S3 URLs.
    
    Parameters:
    
    presignedUrlConfig - Configuration information for pre-signed S3 URLs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetSelection
```
public void setTargetSelection(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    TargetSelection
  - getTargetSelection
```
public String getTargetSelection()
```
    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.
    
    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
  - withTargetSelection
```
public CreateJobRequest 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). 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
public CreateJobRequest 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). 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - setJobExecutionsRolloutConfig
```
public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of the job.
    
    Parameters:
    
    jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.
  - getJobExecutionsRolloutConfig
```
public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()
```
    Allows you to create a staged rollout of the job.
    
    Returns:
    
    Allows you to create a staged rollout of the job.
  - withJobExecutionsRolloutConfig
```
public CreateJobRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of the job.
    
    Parameters:
    
    jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAbortConfig
```
public void setAbortConfig(AbortConfig abortConfig)
```
    Allows you to create criteria to abort a job.
    
    Parameters:
    
    abortConfig - Allows you to create criteria to abort a job.
  - getAbortConfig
```
public AbortConfig getAbortConfig()
```
    Allows you to create criteria to abort a job.
    
    Returns:
    
    Allows you to create criteria to abort a job.
  - withAbortConfig
```
public CreateJobRequest withAbortConfig(AbortConfig abortConfig)
```
    Allows you to create criteria to abort a job.
    
    Parameters:
    
    abortConfig - Allows you to create criteria to abort a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutConfig
```
public void setTimeoutConfig(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.
    
    Parameters:
    
    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.
  - getTimeoutConfig
```
public TimeoutConfig getTimeoutConfig()
```
    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 .
  - withTimeoutConfig
```
public CreateJobRequest withTimeoutConfig(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Metadata which can be used to manage the job.
    
    Returns:
    
    Metadata which can be used to manage the job.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Metadata which can be used to manage the job.
    
    Parameters:
    
    tags - Metadata which can be used to manage the job.
  - withTags
```
public CreateJobRequest withTags(Tag... tags)
```
    Metadata which can be used to manage the job.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Metadata which can be used to manage the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateJobRequest withTags(Collection<Tag> tags)
```
    Metadata which can be used to manage the job.
    
    Parameters:
    
    tags - Metadata which can be used to manage the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateJobRequest

Method Detail

setJobId

getJobId

withJobId

getTargets

setTargets

withTargets

withTargets

setDocumentSource

getDocumentSource

withDocumentSource

setDocument

getDocument

withDocument

setDescription

getDescription

withDescription

setPresignedUrlConfig

getPresignedUrlConfig

withPresignedUrlConfig

setTargetSelection

getTargetSelection

withTargetSelection

withTargetSelection

setJobExecutionsRolloutConfig

getJobExecutionsRolloutConfig

withJobExecutionsRolloutConfig

setAbortConfig

getAbortConfig

withAbortConfig

setTimeoutConfig

getTimeoutConfig

withTimeoutConfig

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone