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

Class ThingGroupDocument

java.lang.Object

software.amazon.awssdk.services.iot.model.ThingGroupDocument

All Implemented Interfaces:

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

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

The thing group search index document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThingGroupDocument.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	The thing group attributes.
static ThingGroupDocument.Builder	builder()
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	hasParentGroupNames()	For responses, this returns true if the service returned a value for the ParentGroupNames property.
List<String>	parentGroupNames()	Parent group names.
List<SdkField<?>>	sdkFields()
static Class<? extends ThingGroupDocument.Builder>	serializableBuilderClass()
String	thingGroupDescription()	The thing group description.
String	thingGroupId()	The thing group ID.
String	thingGroupName()	The thing group name.
ThingGroupDocument.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

thingGroupName

public final String thingGroupName()

The thing group name.

Returns:

The thing group name.

thingGroupId

public final String thingGroupId()

The thing group ID.

Returns:

The thing group ID.

thingGroupDescription

public final String thingGroupDescription()

The thing group description.

Returns:

The thing group description.

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

hasParentGroupNames

public final boolean hasParentGroupNames()

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

parentGroupNames

public final List<String> parentGroupNames()

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

Returns:

Parent group names.

toBuilder

public ThingGroupDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ThingGroupDocument.Builder,ThingGroupDocument>

builder

public static ThingGroupDocument.Builder builder()

serializableBuilderClass

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