com.amazonaws.services.rekognition.model

Class IndexFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.IndexFacesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IndexFacesRequest
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
IndexFacesRequest()

Method Summary

Modifier and Type	Method and Description
IndexFacesRequest	clone()
boolean	equals(Object obj)
String	getCollectionId() The ID of an existing collection to which you want to add the faces that are detected in the input images.
List<String>	getDetectionAttributes() An array of facial attributes that you want to be returned.
String	getExternalImageId() ID you want to assign to all the faces detected in the image.
Image	getImage() The input image as base64-encoded bytes or an S3 object.
Integer	getMaxFaces() The maximum number of faces to index.
String	getQualityFilter() Specifies how much filtering is done to identify faces detected with low quality.
int	hashCode()
void	setCollectionId(String collectionId) The ID of an existing collection to which you want to add the faces that are detected in the input images.
void	setDetectionAttributes(Collection<String> detectionAttributes) An array of facial attributes that you want to be returned.
void	setExternalImageId(String externalImageId) ID you want to assign to all the faces detected in the image.
void	setImage(Image image) The input image as base64-encoded bytes or an S3 object.
void	setMaxFaces(Integer maxFaces) The maximum number of faces to index.
void	setQualityFilter(String qualityFilter) Specifies how much filtering is done to identify faces detected with low quality.
String	toString() Returns a string representation of this object; useful for testing and debugging.
IndexFacesRequest	withCollectionId(String collectionId) The ID of an existing collection to which you want to add the faces that are detected in the input images.
IndexFacesRequest	withDetectionAttributes(Attribute... detectionAttributes) An array of facial attributes that you want to be returned.
IndexFacesRequest	withDetectionAttributes(Collection<String> detectionAttributes) An array of facial attributes that you want to be returned.
IndexFacesRequest	withDetectionAttributes(String... detectionAttributes) An array of facial attributes that you want to be returned.
IndexFacesRequest	withExternalImageId(String externalImageId) ID you want to assign to all the faces detected in the image.
IndexFacesRequest	withImage(Image image) The input image as base64-encoded bytes or an S3 object.
IndexFacesRequest	withMaxFaces(Integer maxFaces) The maximum number of faces to index.
IndexFacesRequest	withQualityFilter(QualityFilter qualityFilter) Specifies how much filtering is done to identify faces detected with low quality.
IndexFacesRequest	withQualityFilter(String qualityFilter) Specifies how much filtering is done to identify faces detected with low quality.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

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

Constructor Detail

IndexFacesRequest

public IndexFacesRequest()

Method Detail

setCollectionId

public void setCollectionId(String collectionId)

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Parameters:

collectionId - The ID of an existing collection to which you want to add the faces that are detected in the input images.

getCollectionId

public String getCollectionId()

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Returns:

The ID of an existing collection to which you want to add the faces that are detected in the input images.

withCollectionId

public IndexFacesRequest withCollectionId(String collectionId)

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Parameters:

collectionId - The ID of an existing collection to which you want to add the faces that are detected in the input images.

Returns:

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

setImage

public void setImage(Image image)

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

Parameters:

image - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

getImage

public Image getImage()

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

Returns:

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

withImage

public IndexFacesRequest withImage(Image image)

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

Parameters:

image - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

Returns:

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

setExternalImageId

public void setExternalImageId(String externalImageId)

ID you want to assign to all the faces detected in the image.

Parameters:

externalImageId - ID you want to assign to all the faces detected in the image.

getExternalImageId

public String getExternalImageId()

ID you want to assign to all the faces detected in the image.

Returns:

ID you want to assign to all the faces detected in the image.

withExternalImageId

public IndexFacesRequest withExternalImageId(String externalImageId)

ID you want to assign to all the faces detected in the image.

Parameters:

externalImageId - ID you want to assign to all the faces detected in the image.

Returns:

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

getDetectionAttributes

public List<String> getDetectionAttributes()

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Returns:

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

See Also:

Attribute

setDetectionAttributes

public void setDetectionAttributes(Collection<String> detectionAttributes)

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Parameters:

detectionAttributes - An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

See Also:

Attribute

withDetectionAttributes

public IndexFacesRequest withDetectionAttributes(String... detectionAttributes)

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

NOTE: This method appends the values to the existing list (if any). Use setDetectionAttributes(java.util.Collection) or withDetectionAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

detectionAttributes - An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Returns:

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

See Also:

Attribute

withDetectionAttributes

public IndexFacesRequest withDetectionAttributes(Collection<String> detectionAttributes)

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Parameters:

detectionAttributes - An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Returns:

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

See Also:

Attribute

withDetectionAttributes

public IndexFacesRequest withDetectionAttributes(Attribute... detectionAttributes)

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Parameters:

detectionAttributes - An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Returns:

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

See Also:

Attribute

setMaxFaces

public void setMaxFaces(Integer maxFaces)

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more that 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces returned by IndexFaces are sorted, in descending order, by the largest face bounding box size, to the smallest.

Parameters:

maxFaces - The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more that 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces returned by IndexFaces are sorted, in descending order, by the largest face bounding box size, to the smallest.

getMaxFaces

public Integer getMaxFaces()

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more that 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces returned by IndexFaces are sorted, in descending order, by the largest face bounding box size, to the smallest.

Returns:

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more that 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces returned by IndexFaces are sorted, in descending order, by the largest face bounding box size, to the smallest.

withMaxFaces

public IndexFacesRequest withMaxFaces(Integer maxFaces)

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more that 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces returned by IndexFaces are sorted, in descending order, by the largest face bounding box size, to the smallest.

Parameters:

maxFaces - The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more that 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces returned by IndexFaces are sorted, in descending order, by the largest face bounding box size, to the smallest.

Returns:

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

setQualityFilter

public void setQualityFilter(String qualityFilter)

Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

Parameters:

qualityFilter - Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

See Also:

QualityFilter

getQualityFilter

public String getQualityFilter()

Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

Returns:

Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

See Also:

QualityFilter

withQualityFilter

public IndexFacesRequest withQualityFilter(String qualityFilter)

Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

Parameters:

qualityFilter - Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

Returns:

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

See Also:

QualityFilter

withQualityFilter

public IndexFacesRequest withQualityFilter(QualityFilter qualityFilter)

Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

Parameters:

qualityFilter - Specifies how much filtering is done to identify faces detected with low quality. Filtered faces are not indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low quality detections can arise for a number of reasons. For example, an object misidentified as a face, a face that is too blurry, or a face with a pose that is too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

Returns:

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

See Also:

QualityFilter

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

Overrides:

clone in class AmazonWebServiceRequest