com.amazonaws.services.iot.model

Class AttributePayload

java.lang.Object

com.amazonaws.services.iot.model.AttributePayload

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttributePayload
extends Object
implements Serializable, Cloneable, StructuredPojo

The attribute payload.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributePayload()

Method Summary

Modifier and Type	Method and Description
AttributePayload	addAttributesEntry(String key, String value)
AttributePayload	clearAttributesEntries() Removes all the entries added into Attributes.
AttributePayload	clone()
boolean	equals(Object obj)
Map<String,String>	getAttributes() A JSON string containing up to three key-value pair in JSON format.
Boolean	getMerge() Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
int	hashCode()
Boolean	isMerge() Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributes(Map<String,String> attributes) A JSON string containing up to three key-value pair in JSON format.
void	setMerge(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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AttributePayload	withAttributes(Map<String,String> attributes) A JSON string containing up to three key-value pair in JSON format.
AttributePayload	withMerge(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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributePayload

public AttributePayload()

Method Detail

getAttributes

public Map<String,String> getAttributes()

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

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

Returns:

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

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

setAttributes

public void setAttributes(Map<String,String> attributes)

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

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

Parameters:

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

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

withAttributes

public AttributePayload withAttributes(Map<String,String> attributes)

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

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

Parameters:

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

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

Returns:

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

addAttributesEntry

public AttributePayload addAttributesEntry(String key,
                                           String value)

clearAttributesEntries

public AttributePayload clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

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

setMerge

public void setMerge(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.

Parameters:

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.

getMerge

public Boolean getMerge()

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.

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.

withMerge

public AttributePayload withMerge(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.

Parameters:

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.

Returns:

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

isMerge

public Boolean isMerge()

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.

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.

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AttributePayload clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.