com.amazonaws.services.iotdata.model

Class UpdateThingShadowRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotdata.model.UpdateThingShadowRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The input for the UpdateThingShadow operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateThingShadowRequest()

Method Summary

Modifier and Type	Method and Description
UpdateThingShadowRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ByteBuffer	getPayload() The state information, in JSON format.
String	getShadowName() The name of the shadow.
String	getThingName() The name of the thing.
int	hashCode()
void	setPayload(ByteBuffer payload) The state information, in JSON format.
void	setShadowName(String shadowName) The name of the shadow.
void	setThingName(String thingName) The name of the thing.
String	toString() Returns a string representation of this object.
UpdateThingShadowRequest	withPayload(ByteBuffer payload) The state information, in JSON format.
UpdateThingShadowRequest	withShadowName(String shadowName) The name of the shadow.
UpdateThingShadowRequest	withThingName(String thingName) The name of the thing.

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

UpdateThingShadowRequest

public UpdateThingShadowRequest()

Method Detail

setThingName

public void setThingName(String thingName)

The name of the thing.

Parameters:

thingName - The name of the thing.

getThingName

public String getThingName()

The name of the thing.

Returns:

The name of the thing.

withThingName

public UpdateThingShadowRequest withThingName(String thingName)

The name of the thing.

Parameters:

thingName - The name of the thing.

Returns:

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

setShadowName

public void setShadowName(String shadowName)

The name of the shadow.

Parameters:

shadowName - The name of the shadow.

getShadowName

public String getShadowName()

The name of the shadow.

Returns:

The name of the shadow.

withShadowName

public UpdateThingShadowRequest withShadowName(String shadowName)

The name of the shadow.

Parameters:

shadowName - The name of the shadow.

Returns:

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

setPayload

public void setPayload(ByteBuffer payload)

The state information, in JSON format.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

payload - The state information, in JSON format.

getPayload

public ByteBuffer getPayload()

The state information, in JSON format.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

The state information, in JSON format.

withPayload

public UpdateThingShadowRequest withPayload(ByteBuffer payload)

The state information, in JSON format.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

payload - The state information, in JSON format.

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