iotdataplane/aws.sdk.kotlin.services.iotdataplane.model/SendDirectMessageRequest/Builder

Builder

class Builder

Properties

clientId

var clientId: String?

The unique identifier of the MQTT client to send the message to.

confirmation

var confirmation: Boolean?

A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.

contentType

var contentType: String?

The MQTT5 content type property forwarded to the receiving client (for example, application/json).

correlationData

var correlationData: String?

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.

payload

var payload: ByteArray?

The message body. MQTT accepts text, binary, and empty (null) message payloads.

payloadFormatIndicator

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

responseTopic

var responseTopic: String?

A UTF-8 encoded string that's used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

timeout

var timeout: Int?

An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.

topic

var topic: String?

The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

userProperties

var userProperties: String?

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.