ThingDocument (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.ThingDocument

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ThingDocument
extends Object
implements Serializable, Cloneable, StructuredPojo

The thing search index document.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ThingDocument()

Constructors
Constructor and Description
`ThingDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ThingDocument`	`addAttributesEntry(String key, String value)`
`ThingDocument`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`ThingDocument`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` The attributes.
`ThingConnectivity`	`getConnectivity()` Indicates whether the thing is connected to the AWS IoT service.
`String`	`getShadow()` The shadow.
`List<String>`	`getThingGroupNames()` Thing group names.
`String`	`getThingId()` The thing ID.
`String`	`getThingName()` The thing name.
`String`	`getThingTypeName()` The thing type name.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Map<String,String> attributes)` The attributes.
`void`	`setConnectivity(ThingConnectivity connectivity)` Indicates whether the thing is connected to the AWS IoT service.
`void`	`setShadow(String shadow)` The shadow.
`void`	`setThingGroupNames(Collection<String> thingGroupNames)` Thing group names.
`void`	`setThingId(String thingId)` The thing ID.
`void`	`setThingName(String thingName)` The thing name.
`void`	`setThingTypeName(String thingTypeName)` The thing type name.
`String`	`toString()` Returns a string representation of this object.
`ThingDocument`	`withAttributes(Map<String,String> attributes)` The attributes.
`ThingDocument`	`withConnectivity(ThingConnectivity connectivity)` Indicates whether the thing is connected to the AWS IoT service.
`ThingDocument`	`withShadow(String shadow)` The shadow.
`ThingDocument`	`withThingGroupNames(Collection<String> thingGroupNames)` Thing group names.
`ThingDocument`	`withThingGroupNames(String... thingGroupNames)` Thing group names.
`ThingDocument`	`withThingId(String thingId)` The thing ID.
`ThingDocument`	`withThingName(String thingName)` The thing name.
`ThingDocument`	`withThingTypeName(String thingTypeName)` The thing type name.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ThingDocument
```
public ThingDocument()
```
- Method Detail
  - setThingName
```
public void setThingName(String thingName)
```
    The thing name.
    
    Parameters:
    
    thingName - The thing name.
  - getThingName
```
public String getThingName()
```
    The thing name.
    
    Returns:
    
    The thing name.
  - withThingName
```
public ThingDocument withThingName(String thingName)
```
    The thing name.
    
    Parameters:
    
    thingName - The thing name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThingId
```
public void setThingId(String thingId)
```
    The thing ID.
    
    Parameters:
    
    thingId - The thing ID.
  - getThingId
```
public String getThingId()
```
    The thing ID.
    
    Returns:
    
    The thing ID.
  - withThingId
```
public ThingDocument withThingId(String thingId)
```
    The thing ID.
    
    Parameters:
    
    thingId - The thing ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThingTypeName
```
public void setThingTypeName(String thingTypeName)
```
    The thing type name.
    
    Parameters:
    
    thingTypeName - The thing type name.
  - getThingTypeName
```
public String getThingTypeName()
```
    The thing type name.
    
    Returns:
    
    The thing type name.
  - withThingTypeName
```
public ThingDocument withThingTypeName(String thingTypeName)
```
    The thing type name.
    
    Parameters:
    
    thingTypeName - The thing type name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getThingGroupNames
```
public List<String> getThingGroupNames()
```
    Thing group names.
    
    Returns:
    
    Thing group names.
  - setThingGroupNames
```
public void setThingGroupNames(Collection<String> thingGroupNames)
```
    Thing group names.
    
    Parameters:
    
    thingGroupNames - Thing group names.
  - withThingGroupNames
```
public ThingDocument withThingGroupNames(String... thingGroupNames)
```
    Thing group names.
    
    NOTE: This method appends the values to the existing list (if any). Use setThingGroupNames(java.util.Collection) or withThingGroupNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    thingGroupNames - Thing group names.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withThingGroupNames
```
public ThingDocument withThingGroupNames(Collection<String> thingGroupNames)
```
    Thing group names.
    
    Parameters:
    
    thingGroupNames - Thing group names.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    The attributes.
    
    Returns:
    
    The attributes.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    The attributes.
    
    Parameters:
    
    attributes - The attributes.
  - withAttributes
```
public ThingDocument withAttributes(Map<String,String> attributes)
```
    The attributes.
    
    Parameters:
    
    attributes - The attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public ThingDocument addAttributesEntry(String key,
                                        String value)
```
  - clearAttributesEntries
```
public ThingDocument clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShadow
```
public void setShadow(String shadow)
```
    The shadow.
    
    Parameters:
    
    shadow - The shadow.
  - getShadow
```
public String getShadow()
```
    The shadow.
    
    Returns:
    
    The shadow.
  - withShadow
```
public ThingDocument withShadow(String shadow)
```
    The shadow.
    
    Parameters:
    
    shadow - The shadow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectivity
```
public void setConnectivity(ThingConnectivity connectivity)
```
    Indicates whether the thing is connected to the AWS IoT service.
    
    Parameters:
    
    connectivity - Indicates whether the thing is connected to the AWS IoT service.
  - getConnectivity
```
public ThingConnectivity getConnectivity()
```
    Indicates whether the thing is connected to the AWS IoT service.
    
    Returns:
    
    Indicates whether the thing is connected to the AWS IoT service.
  - withConnectivity
```
public ThingDocument withConnectivity(ThingConnectivity connectivity)
```
    Indicates whether the thing is connected to the AWS IoT service.
    
    Parameters:
    
    connectivity - Indicates whether the thing is connected to the AWS IoT service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ThingDocument clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ThingDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThingDocument

Method Detail

setThingName

getThingName

withThingName

setThingId

getThingId

withThingId

setThingTypeName

getThingTypeName

withThingTypeName

getThingGroupNames

setThingGroupNames

withThingGroupNames

withThingGroupNames

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setShadow

getShadow

withShadow

setConnectivity

getConnectivity

withConnectivity

toString

equals

hashCode

clone

marshall