Interface GetConnectionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetConnectionResponse.Builder,GetConnectionResponse>, IotDataPlaneResponse.Builder, SdkBuilder<GetConnectionResponse.Builder,GetConnectionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetConnectionResponse
@Mutable @NotThreadSafe public static interface GetConnectionResponse.Builder extends IotDataPlaneResponse.Builder, SdkPojo, CopyableBuilder<GetConnectionResponse.Builder,GetConnectionResponse>

  • Method Details

    • connected

      GetConnectionResponse.Builder connected(Boolean connected)

      The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.

      Parameters:
      connected - The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thingName

      GetConnectionResponse.Builder thingName(String thingName)

      The name of the thing associated with the principal of the MQTT client, if applicable.

      Parameters:
      thingName - The name of the thing associated with the principal of the MQTT client, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cleanSession

      GetConnectionResponse.Builder cleanSession(Boolean cleanSession)

      Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.

      Parameters:
      cleanSession - Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceIp

      GetConnectionResponse.Builder sourceIp(String sourceIp)

      The IP address of the client that initiated the connection.

      Parameters:
      sourceIp - The IP address of the client that initiated the connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourcePort

      GetConnectionResponse.Builder sourcePort(Integer sourcePort)

      The client's source port.

      Parameters:
      sourcePort - The client's source port.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetIp

      GetConnectionResponse.Builder targetIp(String targetIp)

      The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.

      Parameters:
      targetIp - The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetPort

      GetConnectionResponse.Builder targetPort(Integer targetPort)

      The port number of the Amazon Web Services IoT Core endpoint that the client connected to.

      Parameters:
      targetPort - The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keepAliveDuration

      GetConnectionResponse.Builder keepAliveDuration(Integer keepAliveDuration)

      The keep-alive interval in seconds that the client specified when establishing the connection.

      Parameters:
      keepAliveDuration - The keep-alive interval in seconds that the client specified when establishing the connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectedSince

      GetConnectionResponse.Builder connectedSince(Long connectedSince)

      Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.

      Parameters:
      connectedSince - Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disconnectedSince

      GetConnectionResponse.Builder disconnectedSince(Long disconnectedSince)

      Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.

      Parameters:
      disconnectedSince - Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disconnectReason

      GetConnectionResponse.Builder disconnectReason(String disconnectReason)

      The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.

      Parameters:
      disconnectReason - The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionExpiry

      GetConnectionResponse.Builder sessionExpiry(Long sessionExpiry)

      The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.

      Parameters:
      sessionExpiry - The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientId

      GetConnectionResponse.Builder clientId(String clientId)

      The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.

      Parameters:
      clientId - The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcEndpointId

      GetConnectionResponse.Builder vpcEndpointId(String vpcEndpointId)

      The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.

      Parameters:
      vpcEndpointId - The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.