software.amazon.awssdk.services.iotdataplane.model

Interface PublishRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PublishRequest.Builder,PublishRequest>, IotDataPlaneRequest.Builder, SdkBuilder<PublishRequest.Builder,PublishRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PublishRequest

public static interface PublishRequest.Builder
extends IotDataPlaneRequest.Builder, SdkPojo, CopyableBuilder<PublishRequest.Builder,PublishRequest>

Method Summary

Modifier and Type	Method and Description
PublishRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PublishRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PublishRequest.Builder	payload(SdkBytes payload) The message body.
PublishRequest.Builder	qos(Integer qos) The Quality of Service (QoS) level.
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.

Methods inherited from interface software.amazon.awssdk.services.iotdataplane.model.IotDataPlaneRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

topic

PublishRequest.Builder topic(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.

qos

PublishRequest.Builder qos(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.

retain

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

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.

payload

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.

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.

overrideConfiguration

PublishRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PublishRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder