Class GetConnectionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotdataplane.model.IotDataPlaneResponse
software.amazon.awssdk.services.iotdataplane.model.GetConnectionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetConnectionResponse.Builder,GetConnectionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetConnectionResponse extends IotDataPlaneResponse implements ToCopyableBuilder<GetConnectionResponse.Builder,GetConnectionResponse>

  • Method Details

    • connected

      public final Boolean connected()

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

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

    • thingName

      public final String thingName()

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

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

    • cleanSession

      public final Boolean cleanSession()

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

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

    • sourceIp

      public final String sourceIp()

      The IP address of the client that initiated the connection.

      Returns:
      The IP address of the client that initiated the connection.

    • sourcePort

      public final Integer sourcePort()

      The client's source port.

      Returns:
      The client's source port.

    • targetIp

      public final 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.

      Returns:
      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.

    • targetPort

      public final Integer targetPort()

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

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

    • keepAliveDuration

      public final Integer keepAliveDuration()

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

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

    • connectedSince

      public final Long connectedSince()

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

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

    • disconnectedSince

      public final 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.

      Returns:
      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.

    • disconnectReason

      public final String disconnectReason()

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

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

    • sessionExpiry

      public final 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.

      Returns:
      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.

    • clientId

      public final String clientId()

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

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

    • vpcEndpointId

      public final String vpcEndpointId()

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

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

    • toBuilder

      public GetConnectionResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetConnectionResponse.Builder,GetConnectionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetConnectionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetConnectionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.