Class GetThingConnectivityDataResponse

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

  • Method Details

    • thingName

      public final String thingName()

      The name of your IoT thing.

      Returns:
      The name of your IoT thing.

    • connected

      public final Boolean connected()

      A Boolean that indicates the connectivity status.

      Returns:
      A Boolean that indicates the connectivity status.

    • timestamp

      public final Instant timestamp()

      The timestamp of when the device connected or disconnected.

      Returns:
      The timestamp of when the device connected or disconnected.

    • disconnectReason

      public final DisconnectReasonValue disconnectReason()

      The reason that the client is disconnected.

      If the service returns an enum value that is not available in the current SDK version, disconnectReason will return DisconnectReasonValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from disconnectReasonAsString().

      Returns:
      The reason that the client is disconnected.
      See Also:

    • disconnectReasonAsString

      public final String disconnectReasonAsString()

      The reason that the client is disconnected.

      If the service returns an enum value that is not available in the current SDK version, disconnectReason will return DisconnectReasonValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from disconnectReasonAsString().

      Returns:
      The reason that the client is disconnected.
      See Also:

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

      Returns:
      The IP address of the Amazon Web Services IoT Core endpoint that the client 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.

    • vpcEndpointId

      public final String vpcEndpointId()

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

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

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

    • cleanSession

      public final Boolean cleanSession()

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

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

    • sessionExpiry

      public final Long sessionExpiry()

      The session expiry interval in seconds for the MQTT client connection. 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 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.

      Returns:
      The unique identifier of the MQTT client.

    • toBuilder

      public GetThingConnectivityDataResponse.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<GetThingConnectivityDataResponse.Builder,GetThingConnectivityDataResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetThingConnectivityDataResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetThingConnectivityDataResponse.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.