Package software.amazon.awssdk.services.iot.model

Class AssociateTargetsWithJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.AssociateTargetsWithJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateTargetsWithJobRequest.Builder,AssociateTargetsWithJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AssociateTargetsWithJobRequest
extends IotRequest
implements ToCopyableBuilder<AssociateTargetsWithJobRequest.Builder,AssociateTargetsWithJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociateTargetsWithJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AssociateTargetsWithJobRequest.Builder	builder()
String	comment()	An optional comment string describing why the job was associated with the targets.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets()	For responses, this returns true if the service returned a value for the Targets property.
String	jobId()	The unique identifier you assigned to this job when it was created.
String	namespaceId()	The namespace used to indicate that a job is a customer-managed job.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateTargetsWithJobRequest.Builder>	serializableBuilderClass()
List<String>	targets()	A list of thing group ARNs that define the targets of the job.
AssociateTargetsWithJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasTargets

public final boolean hasTargets()

For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targets

public final List<String> targets()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargets() method.

Returns:

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

jobId

public final String jobId()

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.

comment

public final String comment()

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.

namespaceId

public final 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.

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.

toBuilder

public AssociateTargetsWithJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateTargetsWithJobRequest.Builder,AssociateTargetsWithJobRequest>

Specified by:

toBuilder in class IotRequest

builder

public static AssociateTargetsWithJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociateTargetsWithJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo