com.amazonaws.services.iotdata.model

Class PublishRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotdata.model.PublishRequest

All Implemented Interfaces:

Serializable

public class PublishRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the Publish operation.

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide .

See Also:

AWSIotData.publish(PublishRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
PublishRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ByteBuffer	getPayload() The state information, in JSON format.
Integer	getQos() The Quality of Service (QoS) level.
String	getTopic() The name of the MQTT topic.
int	hashCode()
void	setPayload(ByteBuffer payload) The state information, in JSON format.
void	setQos(Integer qos) The Quality of Service (QoS) level.
void	setTopic(String topic) The name of the MQTT topic.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PublishRequest	withPayload(ByteBuffer payload) The state information, in JSON format.
PublishRequest	withQos(Integer qos) The Quality of Service (QoS) level.
PublishRequest	withTopic(String topic) The name of the MQTT topic.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

PublishRequest

public PublishRequest()

Method Detail

getTopic

public String getTopic()

The name of the MQTT topic.

Returns:

The name of the MQTT topic.

setTopic

public void setTopic(String topic)

The name of the MQTT topic.

Parameters:

topic - The name of the MQTT topic.

withTopic

public PublishRequest withTopic(String topic)

The name of the MQTT topic.

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

Parameters:

topic - The name of the MQTT topic.

Returns:

A reference to this updated object so that method calls can be chained together.

getQos

public Integer getQos()

The Quality of Service (QoS) level.

Constraints:
Range: 0 - 1

Returns:

The Quality of Service (QoS) level.

setQos

public void setQos(Integer qos)

The Quality of Service (QoS) level.

Constraints:
Range: 0 - 1

Parameters:

qos - The Quality of Service (QoS) level.

withQos

public PublishRequest withQos(Integer qos)

The Quality of Service (QoS) level.

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

Constraints:
Range: 0 - 1

Parameters:

qos - The Quality of Service (QoS) level.

Returns:

A reference to this updated object so that method calls can be chained together.

getPayload

public ByteBuffer getPayload()

The state information, in JSON format.

Returns:

The state information, in JSON format.

setPayload

public void setPayload(ByteBuffer payload)

The state information, in JSON format.

Parameters:

payload - The state information, in JSON format.

withPayload

public PublishRequest withPayload(ByteBuffer payload)

The state information, in JSON format.

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

Parameters:

payload - The state information, in JSON format.

Returns:

A reference to this updated object so that method calls can be chained together.

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object