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(value="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 and Description
static interface	ThingDocument.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() The attributes.
static ThingDocument.Builder	builder()
ThingConnectivity	connectivity() Indicates whether the thing is connected to the AWS IoT service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasThingGroupNames() Returns true if the ThingGroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends ThingDocument.Builder>	serializableBuilderClass()
String	shadow() The 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()

Returns true if the ThingGroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

thingGroupNames

public final List<String> thingGroupNames()

Thing group names.

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

You can use hasThingGroupNames() to see if a value was sent in this field.

Returns:

Thing group names.

hasAttributes

public final boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public final Map<String,String> attributes()

The attributes.

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

You can use hasAttributes() to see if a value was sent in this field.

Returns:

The attributes.

shadow

public final String shadow()

The shadow.

Returns:

The shadow.

connectivity

public final ThingConnectivity connectivity()

Indicates whether the thing is connected to the AWS IoT service.

Returns:

Indicates whether the thing is connected to the AWS IoT 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