Class ThingDocument
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ThingDocument.Builder,
ThingDocument>
The thing search index document.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe attributes.static ThingDocument.Builder
builder()
final ThingConnectivity
Indicates whether the thing is connected to the Amazon Web Services IoT Core service.final String
Contains Device Defender data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ThingGroupNames property.static Class
<? extends ThingDocument.Builder> final String
shadow()
The unnamed shadow and named shadow.Thing group names.final String
thingId()
The thing ID.final String
The thing name.final String
The thing type name.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
thingName
The thing name.
- Returns:
- The thing name.
-
thingId
The thing ID.
- Returns:
- The thing ID.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ThingDocument.Builder,
ThingDocument> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-