@Generated(value="software.amazon.awssdk:codegen") public final class DescribeThingResponse extends IotResponse implements ToCopyableBuilder<DescribeThingResponse.Builder,DescribeThingResponse>
The output from the DescribeThing operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeThingResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
Map<String,String> |
attributes()
The thing attributes.
|
String |
billingGroupName()
The name of the billing group the thing belongs to.
|
static DescribeThingResponse.Builder |
builder() |
String |
defaultClientId()
The default MQTT client ID.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
boolean |
hasAttributes()
For responses, this returns true if the service returned a value for the Attributes property.
|
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeThingResponse.Builder> |
serializableBuilderClass() |
String |
thingArn()
The ARN of the thing to describe.
|
String |
thingId()
The ID of the thing to describe.
|
String |
thingName()
The name of the thing.
|
String |
thingTypeName()
The thing type name.
|
DescribeThingResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Long |
version()
The current version of the thing record in the registry.
|
responseMetadatasdkHttpResponsecopypublic 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.
This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
public final String thingName()
The name of the thing.
public final String thingId()
The ID of the thing to describe.
public final String thingArn()
The ARN of the thing to describe.
public final String thingTypeName()
The thing type name.
public final boolean hasAttributes()
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.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.
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.
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.
public final String billingGroupName()
The name of the billing group the thing belongs to.
public DescribeThingResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DescribeThingResponse.Builder,DescribeThingResponse>toBuilder in class AwsResponsepublic static DescribeThingResponse.Builder builder()
public static Class<? extends DescribeThingResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.