Class PublishRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.iotdata.model.PublishRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class PublishRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

The input for the Publish operation.

See Also:

  • Constructor Details

    • PublishRequest

      public PublishRequest()

  • Method Details

    • 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.

    • setPayload

      public void setPayload(ByteBuffer payload)

      The state information, in JSON format.

      AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. 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 PublishRequest withPayload(ByteBuffer payload)

      The state information, in JSON format.

      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public PublishRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: