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

Class AttributePayload

java.lang.Object

software.amazon.awssdk.services.iot.model.AttributePayload

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AttributePayload.Builder,AttributePayload>

@Generated("software.amazon.awssdk:codegen")
public final class AttributePayload
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AttributePayload.Builder,AttributePayload>

The attribute payload.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AttributePayload.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	A JSON string containing up to three key-value pair in JSON format.
static AttributePayload.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
Boolean	merge()	Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
List<SdkField<?>>	sdkFields()
static Class<? extends AttributePayload.Builder>	serializableBuilderClass()
AttributePayload.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes 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.

attributes

public final Map<String,String> attributes()

A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

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 hasAttributes() method.

Returns:

A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

merge

public final Boolean merge()

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Returns:

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

toBuilder

public AttributePayload.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributePayload.Builder,AttributePayload>

builder

public static AttributePayload.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo