Interface GetConnectionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetConnectionRequest.Builder,GetConnectionRequest>, IotDataPlaneRequest.Builder, SdkBuilder<GetConnectionRequest.Builder,GetConnectionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetConnectionRequest
@Mutable @NotThreadSafe public static interface GetConnectionRequest.Builder extends IotDataPlaneRequest.Builder, SdkPojo, CopyableBuilder<GetConnectionRequest.Builder,GetConnectionRequest>

  • Method Details

    • clientId

      GetConnectionRequest.Builder clientId(String clientId)

      The unique identifier of the MQTT client to retrieve connection information. 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 retrieve connection information. 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.

    • includeSocketInformation

      GetConnectionRequest.Builder includeSocketInformation(Boolean includeSocketInformation)

      Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to TRUE to include socket information. Set to FALSE to omit socket information. By default, this is set to FALSE. See the developer guide for how to authorize this parameter.

      Parameters:
      includeSocketInformation - Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to TRUE to include socket information. Set to FALSE to omit socket information. By default, this is set to FALSE. See the developer guide for how to authorize this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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