com.amazonaws.services.iot.model

Class ListThingGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.ListThingGroupsRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ListThingGroupsRequest
extends AmazonWebServiceRequest
implements Serializable

List the thing groups in your account.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListThingGroupsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of results to return at one time.
String	getNamePrefixFilter() A filter that limits the results to those with the specified name prefix.
String	getNextToken() The token to retrieve the next set of results.
String	getParentGroup() A filter that limits the results to those with the specified parent group.
Boolean	getRecursive() If true, return child groups as well.
int	hashCode()
Boolean	isRecursive() If true, return child groups as well.
void	setMaxResults(Integer maxResults) The maximum number of results to return at one time.
void	setNamePrefixFilter(String namePrefixFilter) A filter that limits the results to those with the specified name prefix.
void	setNextToken(String nextToken) The token to retrieve the next set of results.
void	setParentGroup(String parentGroup) A filter that limits the results to those with the specified parent group.
void	setRecursive(Boolean recursive) If true, return child groups as well.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListThingGroupsRequest	withMaxResults(Integer maxResults) The maximum number of results to return at one time.
ListThingGroupsRequest	withNamePrefixFilter(String namePrefixFilter) A filter that limits the results to those with the specified name prefix.
ListThingGroupsRequest	withNextToken(String nextToken) The token to retrieve the next set of results.
ListThingGroupsRequest	withParentGroup(String parentGroup) A filter that limits the results to those with the specified parent group.
ListThingGroupsRequest	withRecursive(Boolean recursive) If true, return child groups as well.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListThingGroupsRequest

public ListThingGroupsRequest()

Method Detail

getNextToken

public String getNextToken()

The token to retrieve the next set of results.

Returns:

The token to retrieve the next set of results.

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next set of results.

Parameters:

nextToken -

The token to retrieve the next set of results.

withNextToken

public ListThingGroupsRequest withNextToken(String nextToken)

The token to retrieve the next set of results.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken -

The token to retrieve the next set of results.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

Returns:

The maximum number of results to return at one time.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

Parameters:

maxResults -

The maximum number of results to return at one time.

withMaxResults

public ListThingGroupsRequest withMaxResults(Integer maxResults)

The maximum number of results to return at one time.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 250

Parameters:

maxResults -

The maximum number of results to return at one time.

Returns:

A reference to this updated object so that method calls can be chained together.

getParentGroup

public String getParentGroup()

A filter that limits the results to those with the specified parent group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Returns:

A filter that limits the results to those with the specified parent group.

setParentGroup

public void setParentGroup(String parentGroup)

A filter that limits the results to those with the specified parent group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

parentGroup -

A filter that limits the results to those with the specified parent group.

withParentGroup

public ListThingGroupsRequest withParentGroup(String parentGroup)

A filter that limits the results to those with the specified parent group.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

parentGroup -

A filter that limits the results to those with the specified parent group.

Returns:

A reference to this updated object so that method calls can be chained together.

getNamePrefixFilter

public String getNamePrefixFilter()

A filter that limits the results to those with the specified name prefix.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Returns:

A filter that limits the results to those with the specified name prefix.

setNamePrefixFilter

public void setNamePrefixFilter(String namePrefixFilter)

A filter that limits the results to those with the specified name prefix.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

namePrefixFilter -

A filter that limits the results to those with the specified name prefix.

withNamePrefixFilter

public ListThingGroupsRequest withNamePrefixFilter(String namePrefixFilter)

A filter that limits the results to those with the specified name prefix.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

namePrefixFilter -

A filter that limits the results to those with the specified name prefix.

Returns:

A reference to this updated object so that method calls can be chained together.

isRecursive

public Boolean isRecursive()

If true, return child groups as well.

Returns:

If true, return child groups as well.

getRecursive

public Boolean getRecursive()

If true, return child groups as well.

Returns:

If true, return child groups as well.

setRecursive

public void setRecursive(Boolean recursive)

If true, return child groups as well.

Parameters:

recursive -

If true, return child groups as well.

withRecursive

public ListThingGroupsRequest withRecursive(Boolean recursive)

If true, return child groups as well.

Returns a reference to this object so that method calls can be chained together.

Parameters:

recursive -

If true, return child groups as well.

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