PublishRequest (AWS SDK for Java

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

Constructors
Constructor and Description
`PublishRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PublishRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getContentType()` A UTF-8 encoded string that describes the content of the publishing message.
`String`	`getCorrelationData()` The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
`Long`	`getMessageExpiry()` A user-defined integer value that represents the message expiry interval in seconds.
`ByteBuffer`	`getPayload()` The message body.
`String`	`getPayloadFormatIndicator()` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`Integer`	`getQos()` The Quality of Service (QoS) level.
`String`	`getResponseTopic()` A UTF-8 encoded string that's used as the topic name for a response message.
`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.
`String`	`getUserProperties()` A JSON string that contains an array of JSON objects.
`int`	`hashCode()`
`Boolean`	`isRetain()` A Boolean value that determines whether to set the RETAIN flag when the message is published.
`void`	`setContentType(String contentType)` A UTF-8 encoded string that describes the content of the publishing message.
`void`	`setCorrelationData(String correlationData)` The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
`void`	`setMessageExpiry(Long messageExpiry)` A user-defined integer value that represents the message expiry interval in seconds.
`void`	`setPayload(ByteBuffer payload)` The message body.
`void`	`setPayloadFormatIndicator(String payloadFormatIndicator)` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`void`	`setQos(Integer qos)` The Quality of Service (QoS) level.
`void`	`setResponseTopic(String responseTopic)` A UTF-8 encoded string that's used as the topic name for a response message.
`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.
`void`	`setUserProperties(String userProperties)` A JSON string that contains an array of JSON objects.
`String`	`toString()` Returns a string representation of this object.
`PublishRequest`	`withContentType(String contentType)` A UTF-8 encoded string that describes the content of the publishing message.
`PublishRequest`	`withCorrelationData(String correlationData)` The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.
`PublishRequest`	`withMessageExpiry(Long messageExpiry)` A user-defined integer value that represents the message expiry interval in seconds.
`PublishRequest`	`withPayload(ByteBuffer payload)` The message body.
`PublishRequest`	`withPayloadFormatIndicator(PayloadFormatIndicator payloadFormatIndicator)` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`PublishRequest`	`withPayloadFormatIndicator(String payloadFormatIndicator)` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`PublishRequest`	`withQos(Integer qos)` The Quality of Service (QoS) level.
`PublishRequest`	`withResponseTopic(String responseTopic)` A UTF-8 encoded string that's used as the topic name for a response message.
`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.
`PublishRequest`	`withUserProperties(String userProperties)` A JSON string that contains an array of JSON objects.

Methods inherited from class java.lang.Object
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. The default QoS level is 0.
    
    Parameters:
    
    qos - The Quality of Service (QoS) level. The default QoS level is 0.
  - getQos
```
public Integer getQos()
```
    The Quality of Service (QoS) level. The default QoS level is 0.
    
    Returns:
    
    The Quality of Service (QoS) level. The default QoS level is 0.
  - withQos
```
public PublishRequest withQos(Integer qos)
```
    The Quality of Service (QoS) level. The default QoS level is 0.
    
    Parameters:
    
    qos - The Quality of Service (QoS) level. The default QoS level is 0.
    
    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.
  - setUserProperties
```
public void setUserProperties(String userProperties)
```
    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
    
    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    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.
    
    Parameters:
    
    userProperties - A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
    
    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
  - getUserProperties
```
public String getUserProperties()
```
    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
    
    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    Returns:
    
    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
    
    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
  - withUserProperties
```
public PublishRequest withUserProperties(String userProperties)
```
    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
    
    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    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.
    
    Parameters:
    
    userProperties - A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
    
    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPayloadFormatIndicator
```
public void setPayloadFormatIndicator(String payloadFormatIndicator)
```
    An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    Parameters:
    
    payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    See Also:
    
    PayloadFormatIndicator
  - getPayloadFormatIndicator
```
public String getPayloadFormatIndicator()
```
    An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    Returns:
    
    An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    See Also:
    
    PayloadFormatIndicator
  - withPayloadFormatIndicator
```
public PublishRequest withPayloadFormatIndicator(String payloadFormatIndicator)
```
    An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    Parameters:
    
    payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PayloadFormatIndicator
  - withPayloadFormatIndicator
```
public PublishRequest withPayloadFormatIndicator(PayloadFormatIndicator payloadFormatIndicator)
```
    An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    Parameters:
    
    payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PayloadFormatIndicator
  - setContentType
```
public void setContentType(String contentType)
```
    A UTF-8 encoded string that describes the content of the publishing message.
    
    Parameters:
    
    contentType - A UTF-8 encoded string that describes the content of the publishing message.
  - getContentType
```
public String getContentType()
```
    A UTF-8 encoded string that describes the content of the publishing message.
    
    Returns:
    
    A UTF-8 encoded string that describes the content of the publishing message.
  - withContentType
```
public PublishRequest withContentType(String contentType)
```
    A UTF-8 encoded string that describes the content of the publishing message.
    
    Parameters:
    
    contentType - A UTF-8 encoded string that describes the content of the publishing message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseTopic
```
public void setResponseTopic(String responseTopic)
```
    A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
    
    Parameters:
    
    responseTopic - A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
  - getResponseTopic
```
public String getResponseTopic()
```
    A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
    
    Returns:
    
    A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
  - withResponseTopic
```
public PublishRequest withResponseTopic(String responseTopic)
```
    A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
    
    Parameters:
    
    responseTopic - A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCorrelationData
```
public void setCorrelationData(String correlationData)
```
    The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
    
    Parameters:
    
    correlationData - The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
  - getCorrelationData
```
public String getCorrelationData()
```
    The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
    
    Returns:
    
    The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
  - withCorrelationData
```
public PublishRequest withCorrelationData(String correlationData)
```
    The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
    
    Parameters:
    
    correlationData - The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageExpiry
```
public void setMessageExpiry(Long messageExpiry)
```
    A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
    
    Parameters:
    
    messageExpiry - A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
  - getMessageExpiry
```
public Long getMessageExpiry()
```
    A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
    
    Returns:
    
    A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
  - withMessageExpiry
```
public PublishRequest withMessageExpiry(Long messageExpiry)
```
    A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
    
    Parameters:
    
    messageExpiry - A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
    
    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()
```
    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()

AWS SDK for Java 1.x API Reference - 1.12.771

Class PublishRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PublishRequest

Method Detail

setTopic

getTopic

withTopic

setQos

getQos

withQos

setRetain

getRetain

withRetain

isRetain

setPayload

getPayload

withPayload

setUserProperties

getUserProperties

withUserProperties

setPayloadFormatIndicator

getPayloadFormatIndicator

withPayloadFormatIndicator

withPayloadFormatIndicator

setContentType

getContentType

withContentType

setResponseTopic

getResponseTopic

withResponseTopic

setCorrelationData

getCorrelationData

withCorrelationData

setMessageExpiry

getMessageExpiry

withMessageExpiry

toString

equals

hashCode

clone