com.amazonaws.services.rekognition.model

Class ListFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.ListFacesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListFacesRequest()

Method Summary

Modifier and Type	Method and Description
ListFacesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCollectionId() ID of the collection from which to list the faces.
Integer	getMaxResults() Maximum number of faces to return.
String	getNextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
int	hashCode()
void	setCollectionId(String collectionId) ID of the collection from which to list the faces.
void	setMaxResults(Integer maxResults) Maximum number of faces to return.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListFacesRequest	withCollectionId(String collectionId) ID of the collection from which to list the faces.
ListFacesRequest	withMaxResults(Integer maxResults) Maximum number of faces to return.
ListFacesRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListFacesRequest

public ListFacesRequest()

Method Detail

setCollectionId

public void setCollectionId(String collectionId)

ID of the collection from which to list the faces.

Parameters:

collectionId - ID of the collection from which to list the faces.

getCollectionId

public String getCollectionId()

ID of the collection from which to list the faces.

Returns:

ID of the collection from which to list the faces.

withCollectionId

public ListFacesRequest withCollectionId(String collectionId)

ID of the collection from which to list the faces.

Parameters:

collectionId - ID of the collection from which to list the faces.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Parameters:

nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

getNextToken

public String getNextToken()

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Returns:

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

withNextToken

public ListFacesRequest withNextToken(String nextToken)

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Parameters:

nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Maximum number of faces to return.

Parameters:

maxResults - Maximum number of faces to return.

getMaxResults

public Integer getMaxResults()

Maximum number of faces to return.

Returns:

Maximum number of faces to return.

withMaxResults

public ListFacesRequest withMaxResults(Integer maxResults)

Maximum number of faces to return.

Parameters:

maxResults - Maximum number of faces to return.

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; useful for testing and debugging.

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 ListFacesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()