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 Details

    • 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 ($).

      MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

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

      MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

      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 persistent 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 for persistent sessions. For clean sessions this parameter will be ignored. By default, this is set to FALSE (preserves the session state).

      Parameters:
      cleanSession - Specifies whether to remove the client's persistent 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 for persistent sessions. For clean sessions this parameter will be ignored. 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 ensure that LWT is published. By default, this is set to FALSE (LWT message is published).

      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 ensure that LWT is published. By default, this is set to FALSE (LWT message is published).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DeleteConnectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteConnectionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.