software.amazon.awssdk.services.iotdataplane.model

Class PublishRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotdataplane.model.IotDataPlaneRequest

software.amazon.awssdk.services.iotdataplane.model.PublishRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PublishRequest.Builder,PublishRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PublishRequest
extends IotDataPlaneRequest
implements ToCopyableBuilder<PublishRequest.Builder,PublishRequest>

The input for the Publish operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PublishRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PublishRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SdkBytes	payload() The message body.
Integer	qos() The Quality of Service (QoS) level.
Boolean	retain() A Boolean value that determines whether to set the RETAIN flag when the message is published.
List<SdkField<?>>	sdkFields()
static Class<? extends PublishRequest.Builder>	serializableBuilderClass()
PublishRequest.Builder	toBuilder()
String	topic() The name of the MQTT topic.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

topic

public final String topic()

The name of the MQTT topic.

Returns:

The name of the MQTT topic.

qos

public final Integer qos()

The Quality of Service (QoS) level.

Returns:

The Quality of Service (QoS) level.

retain

public final 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

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

payload

public final 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.

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.

toBuilder

public PublishRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PublishRequest.Builder,PublishRequest>

Specified by:

toBuilder in class IotDataPlaneRequest

builder

public static PublishRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PublishRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo