CreateJobRequest (AWS SDK for Android

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

All Implemented Interfaces:: Serializable, Cloneable

public class CreateJobRequest
extends AmazonWebServiceRequest
implements Serializable

Creates a job.

See Also:: Serialized Form

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)` Parameters for the job document.
`CreateJobRequest`	`cleardocumentParametersEntries()` Removes all the entries added into documentParameters.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A short text description of the job.
`String`	`getDocument()` The job document.
`Map<String,String>`	`getDocumentParameters()` Parameters for 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<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).
`int`	`hashCode()`
`void`	`setDescription(String description)` A short text description of the job.
`void`	`setDocument(String document)` The job document.
`void`	`setDocumentParameters(Map<String,String> documentParameters)` Parameters for 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`	`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`	`setTargetSelection(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`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateJobRequest`	`withDescription(String description)` A short text description of the job.
`CreateJobRequest`	`withDocument(String document)` The job document.
`CreateJobRequest`	`withDocumentParameters(Map<String,String> documentParameters)` Parameters for 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`	`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).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateJobRequest
```
public CreateJobRequest()
```
- Method Detail
  - 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.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    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.
  - 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.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    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:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targets -
    A list of things and thing groups to which the job should be sent.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targets -
    A list of things and thing groups to which the job should be sent.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDocumentSource
```
public String getDocumentSource()
```
    An S3 link to the job document.
    
    Constraints:
    Length: 1 - 1350
    
    Returns:
    
    An S3 link to the job document.
  - setDocumentSource
```
public void setDocumentSource(String documentSource)
```
    An S3 link to the job document.
    
    Constraints:
    Length: 1 - 1350
    
    Parameters:
    
    documentSource -
    An S3 link to the job document.
  - withDocumentSource
```
public CreateJobRequest withDocumentSource(String documentSource)
```
    An S3 link to the job document.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1350
    
    Parameters:
    
    documentSource -
    An S3 link to the job document.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDocument
```
public String getDocument()
```
    The job document.
    
    Constraints:
    Length: - 32768
    
    Returns:
    
    The job document.
  - setDocument
```
public void setDocument(String document)
```
    The job document.
    
    Constraints:
    Length: - 32768
    
    Parameters:
    
    document -
    The job document.
  - withDocument
```
public CreateJobRequest withDocument(String document)
```
    The job document.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 32768
    
    Parameters:
    
    document -
    The job document.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A short text description of the job.
    
    Constraints:
    Length: - 2028
    Pattern: [^\p{C}]+
    
    Returns:
    
    A short text description of the job.
  - setDescription
```
public void setDescription(String description)
```
    A short text description of the job.
    
    Constraints:
    Length: - 2028
    Pattern: [^\p{C}]+
    
    Parameters:
    
    description -
    A short text description of the job.
  - withDescription
```
public CreateJobRequest withDescription(String description)
```
    A short text description of the job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 2028
    Pattern: [^\p{C}]+
    
    Parameters:
    
    description -
    A short text description of the job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPresignedUrlConfig
```
public PresignedUrlConfig getPresignedUrlConfig()
```
    Configuration information for pre-signed S3 URLs.
    
    Returns:
    
    Configuration information for pre-signed S3 URLs.
  - setPresignedUrlConfig
```
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration information for pre-signed S3 URLs.
    
    Parameters:
    
    presignedUrlConfig -
    Configuration information for pre-signed S3 URLs.
  - withPresignedUrlConfig
```
public CreateJobRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration information for pre-signed S3 URLs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    presignedUrlConfig -
    Configuration information for pre-signed S3 URLs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    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
  - 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.
    
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    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
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - setTargetSelection
```
public void setTargetSelection(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.
    
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    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
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - 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.
  - 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.
  - withJobExecutionsRolloutConfig
```
public CreateJobRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of the job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    jobExecutionsRolloutConfig -
    Allows you to create a staged rollout of the job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDocumentParameters
```
public Map<String,String> getDocumentParameters()
```
    Parameters for the job document.
    
    Returns:
    
    Parameters for the job document.
  - setDocumentParameters
```
public void setDocumentParameters(Map<String,String> documentParameters)
```
    Parameters for the job document.
    
    Parameters:
    
    documentParameters -
    Parameters for the job document.
  - withDocumentParameters
```
public CreateJobRequest withDocumentParameters(Map<String,String> documentParameters)
```
    Parameters for the job document.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    documentParameters -
    Parameters for the job document.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - adddocumentParametersEntry
```
public CreateJobRequest adddocumentParametersEntry(String key,
                                                   String value)
```
    Parameters for the job document.
    
    The method adds a new key-value pair into documentParameters parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into documentParameters.
    
    value - The corresponding value of the entry to be added into documentParameters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - cleardocumentParametersEntries
```
public CreateJobRequest cleardocumentParametersEntries()
```
    Removes all the entries added into documentParameters.
    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; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CreateJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateJobRequest

Method Detail

getJobId

setJobId

withJobId

getTargets

setTargets

withTargets

withTargets

getDocumentSource

setDocumentSource

withDocumentSource

getDocument

setDocument

withDocument

getDescription

setDescription

withDescription

getPresignedUrlConfig

setPresignedUrlConfig

withPresignedUrlConfig

getTargetSelection

setTargetSelection

withTargetSelection

setTargetSelection

withTargetSelection

getJobExecutionsRolloutConfig

setJobExecutionsRolloutConfig

withJobExecutionsRolloutConfig

getDocumentParameters

setDocumentParameters

withDocumentParameters

adddocumentParametersEntry

cleardocumentParametersEntries

toString

hashCode

equals