com.amazonaws.services.rekognition.model

Class ListFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.ListFacesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListFacesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListFaces action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListFacesRequest() Default constructor for ListFacesRequest object.
ListFacesRequest(java.lang.String collectionId) Constructs a new ListFacesRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCollectionId() ID of the collection from which to list the faces.
java.lang.Integer	getMaxResults() Maximum number of faces to return.
java.lang.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(java.lang.String collectionId) ID of the collection from which to list the faces.
void	setMaxResults(java.lang.Integer maxResults) Maximum number of faces to return.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListFacesRequest	withCollectionId(java.lang.String collectionId) ID of the collection from which to list the faces.
ListFacesRequest	withMaxResults(java.lang.Integer maxResults) Maximum number of faces to return.
ListFacesRequest	withNextToken(java.lang.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

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

ListFacesRequest

public ListFacesRequest()

Default constructor for ListFacesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

ListFacesRequest

public ListFacesRequest(java.lang.String collectionId)

Constructs a new ListFacesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

collectionId -

ID of the collection from which to list the faces.

Method Detail

getCollectionId

public java.lang.String getCollectionId()

ID of the collection from which to list the faces.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Returns:

ID of the collection from which to list the faces.

setCollectionId

public void setCollectionId(java.lang.String collectionId)

ID of the collection from which to list the faces.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

collectionId -

ID of the collection from which to list the faces.

withCollectionId

public ListFacesRequest withCollectionId(java.lang.String collectionId)

ID of the collection from which to list the faces.

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

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

collectionId -

ID of the collection from which to list the faces.

Returns:

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

getNextToken

public java.lang.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.

Constraints:
Length: - 255

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.

setNextToken

public void setNextToken(java.lang.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.

Constraints:
Length: - 255

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.

withNextToken

public ListFacesRequest withNextToken(java.lang.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.

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

Constraints:
Length: - 255

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:

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

getMaxResults

public java.lang.Integer getMaxResults()

Maximum number of faces to return.

Constraints:
Range: 0 - 4096

Returns:

Maximum number of faces to return.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

Maximum number of faces to return.

Constraints:
Range: 0 - 4096

Parameters:

maxResults -

Maximum number of faces to return.

withMaxResults

public ListFacesRequest withMaxResults(java.lang.Integer maxResults)

Maximum number of faces to return.

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

Constraints:
Range: 0 - 4096

Parameters:

maxResults -

Maximum number of faces to return.

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