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`	`addDocumentParametersEntry(String key, String value)` Add a single DocumentParameters entry
`CreateJobRequest`	`clearDocumentParametersEntries()` Removes all the entries added into DocumentParameters.
`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 the criteria to abort a job.
`String`	`getDescription()` A short text description of the job.
`List<String>`	`getDestinationPackageVersions()` The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
`String`	`getDocument()` The job document.
`Map<String,String>`	`getDocumentParameters()` Parameters of an Amazon Web Services managed template that you can specify to create the job document.
`String`	`getDocumentSource()` An S3 link, or S3 object URL, to the job document.
`JobExecutionsRetryConfig`	`getJobExecutionsRetryConfig()` Allows you to create the criteria to retry a job.
`JobExecutionsRolloutConfig`	`getJobExecutionsRolloutConfig()` Allows you to create a staged rollout of the job.
`String`	`getJobId()` A job identifier which must be unique for your Amazon Web Services account.
`String`	`getJobTemplateArn()` The ARN of the job template used to create the job.
`String`	`getNamespaceId()` The namespace used to indicate that a job is a customer-managed job.
`PresignedUrlConfig`	`getPresignedUrlConfig()` Configuration information for pre-signed S3 URLs.
`SchedulingConfig`	`getSchedulingConfig()` 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.
`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 the criteria to abort a job.
`void`	`setDescription(String description)` A short text description of the job.
`void`	`setDestinationPackageVersions(Collection<String> destinationPackageVersions)` The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
`void`	`setDocument(String document)` The job document.
`void`	`setDocumentParameters(Map<String,String> documentParameters)` Parameters of an Amazon Web Services managed template that you can specify to create the job document.
`void`	`setDocumentSource(String documentSource)` An S3 link, or S3 object URL, to the job document.
`void`	`setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)` Allows you to create the criteria to retry a job.
`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 Amazon Web Services account.
`void`	`setJobTemplateArn(String jobTemplateArn)` The ARN of the job template used to create the job.
`void`	`setNamespaceId(String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`void`	`setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)` Configuration information for pre-signed S3 URLs.
`void`	`setSchedulingConfig(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.
`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 the criteria to abort a job.
`CreateJobRequest`	`withDescription(String description)` A short text description of the job.
`CreateJobRequest`	`withDestinationPackageVersions(Collection<String> destinationPackageVersions)` The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
`CreateJobRequest`	`withDestinationPackageVersions(String... destinationPackageVersions)` The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
`CreateJobRequest`	`withDocument(String document)` The job document.
`CreateJobRequest`	`withDocumentParameters(Map<String,String> documentParameters)` Parameters of an Amazon Web Services managed template that you can specify to create the job document.
`CreateJobRequest`	`withDocumentSource(String documentSource)` An S3 link, or S3 object URL, to the job document.
`CreateJobRequest`	`withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)` Allows you to create the criteria to retry a job.
`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 Amazon Web Services account.
`CreateJobRequest`	`withJobTemplateArn(String jobTemplateArn)` The ARN of the job template used to create the job.
`CreateJobRequest`	`withNamespaceId(String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`CreateJobRequest`	`withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)` Configuration information for pre-signed S3 URLs.
`CreateJobRequest`	`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.
`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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
    
    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
    
    For more information, see Methods for accessing a bucket.
    
    Parameters:
    
    documentSource - An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
    
    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
    
    For more information, see Methods for accessing a bucket.
  - getDocumentSource
```
public String getDocumentSource()
```
    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
    
    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
    
    For more information, see Methods for accessing a bucket.
    
    Returns:
    
    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
    
    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
    
    For more information, see Methods for accessing a bucket.
  - withDocumentSource
```
public CreateJobRequest withDocumentSource(String documentSource)
```
    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
    
    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
    
    For more information, see Methods for accessing a bucket.
    
    Parameters:
    
    documentSource - An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
    
    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
    
    For more information, see Methods for accessing a bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocument
```
public void setDocument(String document)
```
    The job document. Required if you don't specify a value for documentSource.
    
    Parameters:
    
    document - The job document. Required if you don't specify a value for documentSource.
  - getDocument
```
public String getDocument()
```
    The job document. Required if you don't specify a value for documentSource.
    
    Returns:
    
    The job document. Required if you don't specify a value for documentSource.
  - withDocument
```
public CreateJobRequest withDocument(String document)
```
    The job document. Required if you don't specify a value for documentSource.
    
    Parameters:
    
    document - The job document. Required if you don't specify a value for documentSource.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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 the criteria to abort a job.
    
    Parameters:
    
    abortConfig - Allows you to create the criteria to abort a job.
  - getAbortConfig
```
public AbortConfig getAbortConfig()
```
    Allows you to create the criteria to abort a job.
    
    Returns:
    
    Allows you to create the criteria to abort a job.
  - withAbortConfig
```
public CreateJobRequest withAbortConfig(AbortConfig abortConfig)
```
    Allows you to create the criteria to abort a job.
    
    Parameters:
    
    abortConfig - Allows you to create the 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.
  - setNamespaceId
```
public void setNamespaceId(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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
    
    Parameters:
    
    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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
  - getNamespaceId
```
public String getNamespaceId()
```
    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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
    
    Returns:
    
    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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
  - withNamespaceId
```
public CreateJobRequest withNamespaceId(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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
    
    Parameters:
    
    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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobTemplateArn
```
public void setJobTemplateArn(String jobTemplateArn)
```
    The ARN of the job template used to create the job.
    
    Parameters:
    
    jobTemplateArn - The ARN of the job template used to create the job.
  - getJobTemplateArn
```
public String getJobTemplateArn()
```
    The ARN of the job template used to create the job.
    
    Returns:
    
    The ARN of the job template used to create the job.
  - withJobTemplateArn
```
public CreateJobRequest withJobTemplateArn(String jobTemplateArn)
```
    The ARN of the job template used to create the job.
    
    Parameters:
    
    jobTemplateArn - The ARN of the job template used to create the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobExecutionsRetryConfig
```
public void setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
```
    Allows you to create the criteria to retry a job.
    
    Parameters:
    
    jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.
  - getJobExecutionsRetryConfig
```
public JobExecutionsRetryConfig getJobExecutionsRetryConfig()
```
    Allows you to create the criteria to retry a job.
    
    Returns:
    
    Allows you to create the criteria to retry a job.
  - withJobExecutionsRetryConfig
```
public CreateJobRequest withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
```
    Allows you to create the criteria to retry a job.
    
    Parameters:
    
    jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDocumentParameters
```
public Map<String,String> getDocumentParameters()
```
    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.
    
    Returns:
    
    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.
  - setDocumentParameters
```
public void setDocumentParameters(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.
    
    Parameters:
    
    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.
  - withDocumentParameters
```
public CreateJobRequest withDocumentParameters(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDocumentParametersEntry
```
public CreateJobRequest addDocumentParametersEntry(String key,
                                                   String value)
```
    Add a single DocumentParameters entry
    
    See Also:
    
    withDocumentParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearDocumentParametersEntries
```
public CreateJobRequest clearDocumentParametersEntries()
```
    Removes all the entries added into DocumentParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedulingConfig
```
public void setSchedulingConfig(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.
    
    Parameters:
    
    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.
  - getSchedulingConfig
```
public SchedulingConfig getSchedulingConfig()
```
    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.
    
    Returns:
    
    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.
  - withSchedulingConfig
```
public CreateJobRequest 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDestinationPackageVersions
```
public List<String> getDestinationPackageVersions()
```
    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    
    Returns:
    
    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
  - setDestinationPackageVersions
```
public void setDestinationPackageVersions(Collection<String> destinationPackageVersions)
```
    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    
    Parameters:
    
    destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
  - withDestinationPackageVersions
```
public CreateJobRequest withDestinationPackageVersions(String... destinationPackageVersions)
```
    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    
    NOTE: This method appends the values to the existing list (if any). Use setDestinationPackageVersions(java.util.Collection) or withDestinationPackageVersions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDestinationPackageVersions
```
public CreateJobRequest withDestinationPackageVersions(Collection<String> destinationPackageVersions)
```
    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    
    Parameters:
    
    destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
    
    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()

AWS SDK for Java 1.x API Reference - 1.12.773

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

setNamespaceId

getNamespaceId

withNamespaceId

setJobTemplateArn

getJobTemplateArn

withJobTemplateArn

setJobExecutionsRetryConfig

getJobExecutionsRetryConfig

withJobExecutionsRetryConfig

getDocumentParameters

setDocumentParameters

withDocumentParameters

addDocumentParametersEntry

clearDocumentParametersEntries

setSchedulingConfig

getSchedulingConfig

withSchedulingConfig

getDestinationPackageVersions

setDestinationPackageVersions

withDestinationPackageVersions

withDestinationPackageVersions

toString

equals

hashCode

clone