public static interface PublishRequest.Builder extends IotDataPlaneRequest.Builder, SdkPojo, CopyableBuilder<PublishRequest.Builder,PublishRequest>
| Modifier and Type | Method and Description |
|---|---|
PublishRequest.Builder |
contentType(String contentType)
A UTF-8 encoded string that describes the content of the publishing message.
|
PublishRequest.Builder |
correlationData(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.Builder |
messageExpiry(Long messageExpiry)
A user-defined integer value that represents the message expiry interval in seconds.
|
PublishRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PublishRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PublishRequest.Builder |
payload(SdkBytes payload)
The message body.
|
PublishRequest.Builder |
payloadFormatIndicator(PayloadFormatIndicator payloadFormatIndicator)
An
Enum string value that indicates whether the payload is formatted as UTF-8. |
PublishRequest.Builder |
payloadFormatIndicator(String payloadFormatIndicator)
An
Enum string value that indicates whether the payload is formatted as UTF-8. |
PublishRequest.Builder |
qos(Integer qos)
The Quality of Service (QoS) level.
|
PublishRequest.Builder |
responseTopic(String responseTopic)
A UTF-8 encoded string that's used as the topic name for a response message.
|
PublishRequest.Builder |
retain(Boolean retain)
A Boolean value that determines whether to set the RETAIN flag when the message is published.
|
PublishRequest.Builder |
topic(String topic)
The name of the MQTT topic.
|
PublishRequest.Builder |
userProperties(String userProperties)
A JSON string that contains an array of JSON objects.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildPublishRequest.Builder topic(String topic)
The name of the MQTT topic.
topic - The name of the MQTT topic.PublishRequest.Builder qos(Integer qos)
The Quality of Service (QoS) level. The default QoS level is 0.
qos - The Quality of Service (QoS) level. The default QoS level is 0.PublishRequest.Builder retain(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
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
PublishRequest.Builder payload(SdkBytes 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.
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.
PublishRequest.Builder userProperties(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"}]
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"}]
PublishRequest.Builder payloadFormatIndicator(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.
payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8.
payloadFormatIndicator is an HTTP header value in the API.PayloadFormatIndicator,
PayloadFormatIndicatorPublishRequest.Builder payloadFormatIndicator(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.
payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8.
payloadFormatIndicator is an HTTP header value in the API.PayloadFormatIndicator,
PayloadFormatIndicatorPublishRequest.Builder contentType(String contentType)
A UTF-8 encoded string that describes the content of the publishing message.
contentType - A UTF-8 encoded string that describes the content of the publishing message.PublishRequest.Builder responseTopic(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.
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.PublishRequest.Builder correlationData(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.
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.PublishRequest.Builder messageExpiry(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.
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.PublishRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderPublishRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.