Package software.amazon.awssdk.services.iotdataplane.model

Class DeleteConnectionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteConnectionRequest.Builder,DeleteConnectionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteConnectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteConnectionRequest.Builder	builder()
Boolean	cleanSession()	Specifies whether to remove the client's session state when disconnecting.
String	clientId()	The unique identifier of the MQTT client to disconnect.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	preventWillMessage()	Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteConnectionRequest.Builder>	serializableBuilderClass()
DeleteConnectionRequest.Builder	toBuilder()
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

clientId

public final String clientId()

The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($).

Returns:

The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($).

cleanSession

public final Boolean cleanSession()

Specifies whether to remove the client's session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state. By default, this is set to FALSE (preserves the session state).

Returns:

Specifies whether to remove the client's session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state. By default, this is set to FALSE (preserves the session state).

preventWillMessage

public final Boolean preventWillMessage()

Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to allow publishing. By default, this is set to FALSE (allows publishing the LWT message).

Returns:

Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to allow publishing. By default, this is set to FALSE (allows publishing the LWT message).

toBuilder

public DeleteConnectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteConnectionRequest.Builder,DeleteConnectionRequest>

Specified by:

toBuilder in class IotDataPlaneRequest

builder

public static DeleteConnectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteConnectionRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo