Class PublishRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
The input for the Publish operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The state information, in JSON format.getQos()
The Quality of Service (QoS) level.getTopic()
The name of the MQTT topic.int
hashCode()
void
setPayload
(ByteBuffer payload) The state information, in JSON format.void
The Quality of Service (QoS) level.void
The name of the MQTT topic.toString()
Returns a string representation of this object; useful for testing and debugging.withPayload
(ByteBuffer payload) The state information, in JSON format.The Quality of Service (QoS) level.The name of the MQTT topic.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PublishRequest
public PublishRequest()
-
-
Method Details
-
setTopic
The name of the MQTT topic.
- Parameters:
topic
- The name of the MQTT topic.
-
getTopic
The name of the MQTT topic.
- Returns:
- The name of the MQTT topic.
-
withTopic
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
The Quality of Service (QoS) level.
- Parameters:
qos
- The Quality of Service (QoS) level.
-
getQos
The Quality of Service (QoS) level.
- Returns:
- The Quality of Service (QoS) level.
-
withQos
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
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
The state information, in JSON format.
ByteBuffer
s are stateful. Calling theirget
methods changes theirposition
. We recommend usingByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independentposition
, and callingget
methods on this rather than directly on the returnedByteBuffer
. Doing so will ensure that anyone else using theByteBuffer
will not be affected by changes to theposition
.- Returns:
- The state information, in JSON format.
-
withPayload
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-