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

Class DescribeThingResponse

    • Method Detail

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

      • 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