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

Interface DeleteConnectionRequest.Builder

All Superinterfaces:

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

Enclosing class:

DeleteConnectionRequest

@Mutable
@NotThreadSafe
public static interface DeleteConnectionRequest.Builder
extends IotDataPlaneRequest.Builder, SdkPojo, CopyableBuilder<DeleteConnectionRequest.Builder,DeleteConnectionRequest>

Method Summary

Modifier and Type	Method	Description
DeleteConnectionRequest.Builder	cleanSession(Boolean cleanSession)	Specifies whether to remove the client's session state when disconnecting.
DeleteConnectionRequest.Builder	clientId(String clientId)	The unique identifier of the MQTT client to disconnect.
DeleteConnectionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DeleteConnectionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DeleteConnectionRequest.Builder	preventWillMessage(Boolean preventWillMessage)	Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection.

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

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

clientId

DeleteConnectionRequest.Builder clientId(String clientId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cleanSession

DeleteConnectionRequest.Builder cleanSession(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

preventWillMessage

DeleteConnectionRequest.Builder preventWillMessage(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DeleteConnectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder