com.amazonaws.services.iot.model

Class ListThingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.ListThingsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListThingsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListThingsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAttributeName() The attribute name used to search for things.
java.lang.String	getAttributeValue() The attribute value used to search for things.
java.lang.Integer	getMaxResults() The maximum number of results to return in this operation.
java.lang.String	getNextToken() To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
java.lang.String	getThingTypeName() The name of the thing type used to search for things.
int	hashCode()
void	setAttributeName(java.lang.String attributeName) The attribute name used to search for things.
void	setAttributeValue(java.lang.String attributeValue) The attribute value used to search for things.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return in this operation.
void	setNextToken(java.lang.String nextToken) To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
void	setThingTypeName(java.lang.String thingTypeName) The name of the thing type used to search for things.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListThingsRequest	withAttributeName(java.lang.String attributeName) The attribute name used to search for things.
ListThingsRequest	withAttributeValue(java.lang.String attributeValue) The attribute value used to search for things.
ListThingsRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return in this operation.
ListThingsRequest	withNextToken(java.lang.String nextToken) To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
ListThingsRequest	withThingTypeName(java.lang.String thingTypeName) The name of the thing type used to search for things.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListThingsRequest

public ListThingsRequest()

Method Detail

getNextToken

public java.lang.String getNextToken()

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Returns:

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

setNextToken

public void setNextToken(java.lang.String nextToken)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Parameters:

nextToken -

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

withNextToken

public ListThingsRequest withNextToken(java.lang.String nextToken)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

Parameters:

nextToken -

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Returns:

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

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

Returns:

The maximum number of results to return in this operation.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

Parameters:

maxResults -

The maximum number of results to return in this operation.

withMaxResults

public ListThingsRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results to return in this operation.

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 in this operation.

Returns:

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

getAttributeName

public java.lang.String getAttributeName()

The attribute name used to search for things.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_.,@/:#-]+

Returns:

The attribute name used to search for things.

setAttributeName

public void setAttributeName(java.lang.String attributeName)

The attribute name used to search for things.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_.,@/:#-]+

Parameters:

attributeName -

The attribute name used to search for things.

withAttributeName

public ListThingsRequest withAttributeName(java.lang.String attributeName)

The attribute name used to search for things.

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

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_.,@/:#-]+

Parameters:

attributeName -

The attribute name used to search for things.

Returns:

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

getAttributeValue

public java.lang.String getAttributeValue()

The attribute value used to search for things.

Constraints:
Length: - 800
Pattern: [a-zA-Z0-9_.,@/:#-]*

Returns:

The attribute value used to search for things.

setAttributeValue

public void setAttributeValue(java.lang.String attributeValue)

The attribute value used to search for things.

Constraints:
Length: - 800
Pattern: [a-zA-Z0-9_.,@/:#-]*

Parameters:

attributeValue -

The attribute value used to search for things.

withAttributeValue

public ListThingsRequest withAttributeValue(java.lang.String attributeValue)

The attribute value used to search for things.

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

Constraints:
Length: - 800
Pattern: [a-zA-Z0-9_.,@/:#-]*

Parameters:

attributeValue -

The attribute value used to search for things.

Returns:

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

getThingTypeName

public java.lang.String getThingTypeName()

The name of the thing type used to search for things.

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

Returns:

The name of the thing type used to search for things.

setThingTypeName

public void setThingTypeName(java.lang.String thingTypeName)

The name of the thing type used to search for things.

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

Parameters:

thingTypeName -

The name of the thing type used to search for things.

withThingTypeName

public ListThingsRequest withThingTypeName(java.lang.String thingTypeName)

The name of the thing type used to search for things.

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

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

Parameters:

thingTypeName -

The name of the thing type used to search for things.

Returns:

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

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object