ThingGroupDocument (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

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)` Add a single Attributes entry
`ThingGroupDocument`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`ThingGroupDocument`	`clone()`
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ThingGroupDocument
```
public ThingGroupDocument()
```
- Method Detail
  - setThingGroupName
```
public void setThingGroupName(String thingGroupName)
```
    The thing group name.
    
    Parameters:
    
    thingGroupName - The thing group name.
  - getThingGroupName
```
public String getThingGroupName()
```
    The thing group name.
    
    Returns:
    
    The thing group name.
  - withThingGroupName
```
public ThingGroupDocument withThingGroupName(String thingGroupName)
```
    The thing group name.
    
    Parameters:
    
    thingGroupName - The thing group name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThingGroupId
```
public void setThingGroupId(String thingGroupId)
```
    The thing group ID.
    
    Parameters:
    
    thingGroupId - The thing group ID.
  - getThingGroupId
```
public String getThingGroupId()
```
    The thing group ID.
    
    Returns:
    
    The thing group ID.
  - withThingGroupId
```
public ThingGroupDocument withThingGroupId(String thingGroupId)
```
    The thing group ID.
    
    Parameters:
    
    thingGroupId - The thing group ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThingGroupDescription
```
public void setThingGroupDescription(String thingGroupDescription)
```
    The thing group description.
    
    Parameters:
    
    thingGroupDescription - The thing group description.
  - getThingGroupDescription
```
public String getThingGroupDescription()
```
    The thing group description.
    
    Returns:
    
    The thing group description.
  - withThingGroupDescription
```
public ThingGroupDocument withThingGroupDescription(String thingGroupDescription)
```
    The thing group description.
    
    Parameters:
    
    thingGroupDescription - The thing group description.
    
    Returns:
    
    Returns a reference to this 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.
    
    Parameters:
    
    attributes - The thing group attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public ThingGroupDocument addAttributesEntry(String key,
                                             String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public ThingGroupDocument clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setParentGroupNames(java.util.Collection) or withParentGroupNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parentGroupNames - Parent group names.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParentGroupNames
```
public ThingGroupDocument withParentGroupNames(Collection<String> parentGroupNames)
```
    Parent group names.
    
    Parameters:
    
    parentGroupNames - Parent group names.
    
    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 ThingGroupDocument 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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class ThingGroupDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThingGroupDocument

Method Detail

setThingGroupName

getThingGroupName

withThingGroupName

setThingGroupId

getThingGroupId

withThingGroupId

setThingGroupDescription

getThingGroupDescription

withThingGroupDescription

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getParentGroupNames

setParentGroupNames

withParentGroupNames

withParentGroupNames

toString

equals

hashCode

clone

marshall