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

Class ThingDocument

java.lang.Object

software.amazon.awssdk.services.iot.model.ThingDocument

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ThingDocument.Builder,ThingDocument>

@Generated("software.amazon.awssdk:codegen")
public final class ThingDocument
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ThingDocument.Builder,ThingDocument>

The thing search index document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThingDocument.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	The attributes.
static ThingDocument.Builder	builder()
ThingConnectivity	connectivity()	Indicates whether the thing is connected to the Amazon Web Services IoT Core service.
String	deviceDefender()	Contains Device Defender data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
boolean	hasThingGroupNames()	For responses, this returns true if the service returned a value for the ThingGroupNames property.
List<SdkField<?>>	sdkFields()
static Class<? extends ThingDocument.Builder>	serializableBuilderClass()
String	shadow()	The unnamed shadow and named shadow.
List<String>	thingGroupNames()	Thing group names.
String	thingId()	The thing ID.
String	thingName()	The thing name.
String	thingTypeName()	The thing type name.
ThingDocument.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

thingName

public final String thingName()

The thing name.

Returns:

The thing name.

thingId

public final String thingId()

The thing ID.

Returns:

The thing ID.

thingTypeName

public final String thingTypeName()

The thing type name.

Returns:

The thing type name.

hasThingGroupNames

public final boolean hasThingGroupNames()

For responses, this returns true if the service returned a value for the ThingGroupNames 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.

thingGroupNames

public final List<String> thingGroupNames()

Thing group names.

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 hasThingGroupNames() method.

Returns:

Thing group names.

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

shadow

public final String shadow()

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

Returns:

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

deviceDefender

public final String deviceDefender()

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

Returns:

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

connectivity

public final ThingConnectivity connectivity()

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

Returns:

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

toBuilder

public ThingDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ThingDocument.Builder,ThingDocument>

builder

public static ThingDocument.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo