com.amazonaws.services.iot.model

Class AssociateTargetsWithJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.AssociateTargetsWithJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssociateTargetsWithJobRequest
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
AssociateTargetsWithJobRequest()

Method Summary

Modifier and Type	Method and Description
AssociateTargetsWithJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getComment() An optional comment string describing why the job was associated with the targets.
String	getJobId() The unique identifier you assigned to this job when it was created.
String	getNamespaceId() The namespace used to indicate that a job is a customer-managed job.
List<String>	getTargets() A list of thing group ARNs that define the targets of the job.
int	hashCode()
void	setComment(String comment) An optional comment string describing why the job was associated with the targets.
void	setJobId(String jobId) The unique identifier you assigned to this job when it was created.
void	setNamespaceId(String namespaceId) The namespace used to indicate that a job is a customer-managed job.
void	setTargets(Collection<String> targets) A list of thing group ARNs that define the targets of the job.
String	toString() Returns a string representation of this object.
AssociateTargetsWithJobRequest	withComment(String comment) An optional comment string describing why the job was associated with the targets.
AssociateTargetsWithJobRequest	withJobId(String jobId) The unique identifier you assigned to this job when it was created.
AssociateTargetsWithJobRequest	withNamespaceId(String namespaceId) The namespace used to indicate that a job is a customer-managed job.
AssociateTargetsWithJobRequest	withTargets(Collection<String> targets) A list of thing group ARNs that define the targets of the job.
AssociateTargetsWithJobRequest	withTargets(String... targets) A list of thing group ARNs that define the targets of the job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssociateTargetsWithJobRequest

public AssociateTargetsWithJobRequest()

Method Detail

getTargets

public List<String> getTargets()

A list of thing group ARNs that define the targets of the job.

Returns:

A list of thing group ARNs that define the targets of the job.

setTargets

public void setTargets(Collection<String> targets)

A list of thing group ARNs that define the targets of the job.

Parameters:

targets - A list of thing group ARNs that define the targets of the job.

withTargets

public AssociateTargetsWithJobRequest withTargets(String... targets)

A list of thing group ARNs that define the targets of the job.

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 thing group ARNs that define the targets of the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargets

public AssociateTargetsWithJobRequest withTargets(Collection<String> targets)

A list of thing group ARNs that define the targets of the job.

Parameters:

targets - A list of thing group ARNs that define the targets of the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setJobId

public void setJobId(String jobId)

The unique identifier you assigned to this job when it was created.

Parameters:

jobId - The unique identifier you assigned to this job when it was created.

getJobId

public String getJobId()

The unique identifier you assigned to this job when it was created.

Returns:

The unique identifier you assigned to this job when it was created.

withJobId

public AssociateTargetsWithJobRequest withJobId(String jobId)

The unique identifier you assigned to this job when it was created.

Parameters:

jobId - The unique identifier you assigned to this job when it was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

setComment

public void setComment(String comment)

An optional comment string describing why the job was associated with the targets.

Parameters:

comment - An optional comment string describing why the job was associated with the targets.

getComment

public String getComment()

An optional comment string describing why the job was associated with the targets.

Returns:

An optional comment string describing why the job was associated with the targets.

withComment

public AssociateTargetsWithJobRequest withComment(String comment)

An optional comment string describing why the job was associated with the targets.

Parameters:

comment - An optional comment string describing why the job was associated with the targets.

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 AssociateTargetsWithJobRequest 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.

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 AssociateTargetsWithJobRequest 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()