com.amazonaws.services.iotdata.model

Class PublishRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotdata.model.PublishRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The input for the Publish operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PublishRequest()

Method Summary

Modifier and Type	Method and Description
PublishRequest	clone()
boolean	equals(Object obj)
ByteBuffer	getPayload() The message body.
Integer	getQos() The Quality of Service (QoS) level.
Boolean	getRetain() A Boolean value that determines whether to set the RETAIN flag when the message is published.
String	getTopic() The name of the MQTT topic.
int	hashCode()
Boolean	isRetain() A Boolean value that determines whether to set the RETAIN flag when the message is published.
void	setPayload(ByteBuffer payload) The message body.
void	setQos(Integer qos) The Quality of Service (QoS) level.
void	setRetain(Boolean retain) A Boolean value that determines whether to set the RETAIN flag when the message is published.
void	setTopic(String topic) The name of the MQTT topic.
String	toString() Returns a string representation of this object.
PublishRequest	withPayload(ByteBuffer payload) The message body.
PublishRequest	withQos(Integer qos) The Quality of Service (QoS) level.
PublishRequest	withRetain(Boolean retain) A Boolean value that determines whether to set the RETAIN flag when the message is published.
PublishRequest	withTopic(String topic) The name of the MQTT topic.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

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

Constructor Detail

PublishRequest

public PublishRequest()

Method Detail

setTopic

public void setTopic(String topic)

The name of the MQTT topic.

Parameters:

topic - The name of the MQTT topic.

getTopic

public String getTopic()

The name of the MQTT topic.

Returns:

The name of the MQTT topic.

withTopic

public PublishRequest withTopic(String topic)

The name of the MQTT topic.

Parameters:

topic - The name of the MQTT topic.

Returns:

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

setQos

public void setQos(Integer qos)

The Quality of Service (QoS) level.

Parameters:

qos - The Quality of Service (QoS) level.

getQos

public Integer getQos()

The Quality of Service (QoS) level.

Returns:

The Quality of Service (QoS) level.

withQos

public PublishRequest withQos(Integer qos)

The Quality of Service (QoS) level.

Parameters:

qos - The Quality of Service (QoS) level.

Returns:

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

setRetain

public void setRetain(Boolean retain)

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

Parameters:

retain - A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

getRetain

public Boolean getRetain()

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

Returns:

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

withRetain

public PublishRequest withRetain(Boolean retain)

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

Parameters:

retain - A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

Returns:

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

isRetain

public Boolean isRetain()

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

Returns:

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

setPayload

public void setPayload(ByteBuffer payload)

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

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 message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

getPayload

public ByteBuffer getPayload()

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

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 message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

withPayload

public PublishRequest withPayload(ByteBuffer payload)

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

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 message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

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

Overrides:

clone in class AmazonWebServiceRequest