ThingGroupDocument (AWS SDK for Android

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

All Implemented Interfaces:

Serializable
```
public class ThingGroupDocument
extends Object
implements Serializable
```
The thing group search index document.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ThingGroupDocument()

Constructors
Constructor and Description
`ThingGroupDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ThingGroupDocument`	`addattributesEntry(String key, String value)` The thing group attributes.
`ThingGroupDocument`	`clearattributesEntries()` Removes all the entries added into attributes.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` The thing group attributes.
`List<String>`	`getParentGroupNames()` Parent group names.
`String`	`getThingGroupDescription()` The thing group description.
`String`	`getThingGroupId()` The thing group ID.
`String`	`getThingGroupName()` The thing group name.
`int`	`hashCode()`
`void`	`setAttributes(Map<String,String> attributes)` The thing group attributes.
`void`	`setParentGroupNames(Collection<String> parentGroupNames)` Parent group names.
`void`	`setThingGroupDescription(String thingGroupDescription)` The thing group description.
`void`	`setThingGroupId(String thingGroupId)` The thing group ID.
`void`	`setThingGroupName(String thingGroupName)` The thing group name.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ThingGroupDocument`	`withAttributes(Map<String,String> attributes)` The thing group attributes.
`ThingGroupDocument`	`withParentGroupNames(Collection<String> parentGroupNames)` Parent group names.
`ThingGroupDocument`	`withParentGroupNames(String... parentGroupNames)` Parent group names.
`ThingGroupDocument`	`withThingGroupDescription(String thingGroupDescription)` The thing group description.
`ThingGroupDocument`	`withThingGroupId(String thingGroupId)` The thing group ID.
`ThingGroupDocument`	`withThingGroupName(String thingGroupName)` The thing group name.

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

- Constructor Detail
  - ThingGroupDocument
```
public ThingGroupDocument()
```
- Method Detail
  - getThingGroupName
```
public String getThingGroupName()
```
    The thing group name.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Returns:
    
    The thing group name.
  - setThingGroupName
```
public void setThingGroupName(String thingGroupName)
```
    The thing group name.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    thingGroupName -
    The thing group name.
  - withThingGroupName
```
public ThingGroupDocument withThingGroupName(String thingGroupName)
```
    The thing group name.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    thingGroupName -
    The thing group name.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getThingGroupId
```
public String getThingGroupId()
```
    The thing group ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9\-]+
    
    Returns:
    
    The thing group ID.
  - setThingGroupId
```
public void setThingGroupId(String thingGroupId)
```
    The thing group ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9\-]+
    
    Parameters:
    
    thingGroupId -
    The thing group ID.
  - withThingGroupId
```
public ThingGroupDocument withThingGroupId(String thingGroupId)
```
    The thing group ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9\-]+
    
    Parameters:
    
    thingGroupId -
    The thing group ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getThingGroupDescription
```
public String getThingGroupDescription()
```
    The thing group description.
    
    Constraints:
    Length: - 2028
    Pattern: [\p{Graph}\x20]*
    
    Returns:
    
    The thing group description.
  - setThingGroupDescription
```
public void setThingGroupDescription(String thingGroupDescription)
```
    The thing group description.
    
    Constraints:
    Length: - 2028
    Pattern: [\p{Graph}\x20]*
    
    Parameters:
    
    thingGroupDescription -
    The thing group description.
  - withThingGroupDescription
```
public ThingGroupDocument withThingGroupDescription(String thingGroupDescription)
```
    The thing group description.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 2028
    Pattern: [\p{Graph}\x20]*
    
    Parameters:
    
    thingGroupDescription -
    The thing group description.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    The thing group attributes.
    
    Returns:
    
    The thing group attributes.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    The thing group attributes.
    
    Parameters:
    
    attributes -
    The thing group attributes.
  - withAttributes
```
public ThingGroupDocument withAttributes(Map<String,String> attributes)
```
    The thing group attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributes -
    The thing group attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addattributesEntry
```
public ThingGroupDocument addattributesEntry(String key,
                                             String value)
```
    The thing group attributes.
    
    The method adds a new key-value pair into attributes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into attributes.
    
    value - The corresponding value of the entry to be added into attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearattributesEntries
```
public ThingGroupDocument clearattributesEntries()
```
    Removes all the entries added into attributes.
    Returns a reference to this object so that method calls can be chained together.
  - getParentGroupNames
```
public List<String> getParentGroupNames()
```
    Parent group names.
    
    Returns:
    
    Parent group names.
  - setParentGroupNames
```
public void setParentGroupNames(Collection<String> parentGroupNames)
```
    Parent group names.
    
    Parameters:
    
    parentGroupNames -
    Parent group names.
  - withParentGroupNames
```
public ThingGroupDocument withParentGroupNames(String... parentGroupNames)
```
    Parent group names.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    parentGroupNames -
    Parent group names.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withParentGroupNames
```
public ThingGroupDocument withParentGroupNames(Collection<String> parentGroupNames)
```
    Parent group names.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    parentGroupNames -
    Parent group names.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ThingGroupDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThingGroupDocument

Method Detail

getThingGroupName

setThingGroupName

withThingGroupName

getThingGroupId

setThingGroupId

withThingGroupId

getThingGroupDescription

setThingGroupDescription

withThingGroupDescription

getAttributes

setAttributes

withAttributes

addattributesEntry

clearattributesEntries

getParentGroupNames

setParentGroupNames

withParentGroupNames

withParentGroupNames

toString

hashCode

equals