Package software.amazon.awssdk.services.iot.model

Class DescribeThingResponse

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.DescribeThingResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeThingResponse.Builder,DescribeThingResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeThingResponse extends IotResponse implements ToCopyableBuilder<DescribeThingResponse.Builder,DescribeThingResponse>

The output from the DescribeThing operation.

  • Method Details

    • defaultClientId

      public final String defaultClientId()

      The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

      This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

      Returns:
      The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

      This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

    • thingName

      public final String thingName()

      The name of the thing.

      Returns:
      The name of the thing.

    • thingId

      public final String thingId()

      The ID of the thing to describe.

      Returns:
      The ID of the thing to describe.

    • thingArn

      public final String thingArn()

      The ARN of the thing to describe.

      Returns:
      The ARN of the thing to describe.

    • thingTypeName

      public final String thingTypeName()

      The thing type name.

      Returns:
      The thing type name.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributes

      public final Map<String,String> attributes()

      The thing attributes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The thing attributes.

    • version

      public final Long version()

      The current version of the thing record in the registry.

      To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

      Returns:
      The current version of the thing record in the registry.

      To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

    • billingGroupName

      public final String billingGroupName()

      The name of the billing group the thing belongs to.

      Returns:
      The name of the billing group the thing belongs to.

    • toBuilder

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

    • builder

      public static DescribeThingResponse.Builder builder()

    • serializableBuilderClass

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