public class AssociateTargetsWithJobRequest extends AmazonWebServiceRequest implements java.io.Serializable
Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the targetSelection
field
set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed 100.
Constructor and Description |
---|
AssociateTargetsWithJobRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getComment()
An optional comment string describing why the job was associated with the
targets.
|
java.lang.String |
getJobId()
The unique identifier you assigned to this job when it was created.
|
java.lang.String |
getNamespaceId()
The namespace used to indicate that a job is a customer-managed job.
|
java.util.List<java.lang.String> |
getTargets()
A list of thing group ARNs that define the targets of the job.
|
int |
hashCode() |
void |
setComment(java.lang.String comment)
An optional comment string describing why the job was associated with the
targets.
|
void |
setJobId(java.lang.String jobId)
The unique identifier you assigned to this job when it was created.
|
void |
setNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
void |
setTargets(java.util.Collection<java.lang.String> targets)
A list of thing group ARNs that define the targets of the job.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
AssociateTargetsWithJobRequest |
withComment(java.lang.String comment)
An optional comment string describing why the job was associated with the
targets.
|
AssociateTargetsWithJobRequest |
withJobId(java.lang.String jobId)
The unique identifier you assigned to this job when it was created.
|
AssociateTargetsWithJobRequest |
withNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
AssociateTargetsWithJobRequest |
withTargets(java.util.Collection<java.lang.String> targets)
A list of thing group ARNs that define the targets of the job.
|
AssociateTargetsWithJobRequest |
withTargets(java.lang.String... targets)
A list of thing group ARNs that define the targets of the job.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.util.List<java.lang.String> getTargets()
A list of thing group ARNs that define the targets of the job.
A list of thing group ARNs that define the targets of the job.
public void setTargets(java.util.Collection<java.lang.String> targets)
A list of thing group ARNs that define the targets of the job.
targets
- A list of thing group ARNs that define the targets of the job.
public AssociateTargetsWithJobRequest withTargets(java.lang.String... targets)
A list of thing group ARNs that define the targets of the job.
Returns a reference to this object so that method calls can be chained together.
targets
- A list of thing group ARNs that define the targets of the job.
public AssociateTargetsWithJobRequest withTargets(java.util.Collection<java.lang.String> targets)
A list of thing group ARNs that define the targets of the job.
Returns a reference to this object so that method calls can be chained together.
targets
- A list of thing group ARNs that define the targets of the job.
public java.lang.String getJobId()
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
The unique identifier you assigned to this job when it was created.
public void setJobId(java.lang.String jobId)
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
jobId
- The unique identifier you assigned to this job when it was created.
public AssociateTargetsWithJobRequest withJobId(java.lang.String jobId)
The unique identifier you assigned to this job when it was created.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
jobId
- The unique identifier you assigned to this job when it was created.
public java.lang.String getComment()
An optional comment string describing why the job was associated with the targets.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
An optional comment string describing why the job was associated with the targets.
public void setComment(java.lang.String comment)
An optional comment string describing why the job was associated with the targets.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
comment
- An optional comment string describing why the job was associated with the targets.
public AssociateTargetsWithJobRequest withComment(java.lang.String comment)
An optional comment string describing why the job was associated with the targets.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
comment
- An optional comment string describing why the job was associated with the targets.
public java.lang.String getNamespaceId()
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
public void setNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
namespaceId
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
public AssociateTargetsWithJobRequest withNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
namespaceId
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.