com.amazonaws.services.rekognition.model

Class SearchFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.SearchFacesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
SearchFacesRequest	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 the face belongs to.
String	getFaceId() ID of a face to find matches for in the collection.
Float	getFaceMatchThreshold() Optional value specifying the minimum confidence in the face match to return.
Integer	getMaxFaces() Maximum number of faces to return.
int	hashCode()
void	setCollectionId(String collectionId) ID of the collection the face belongs to.
void	setFaceId(String faceId) ID of a face to find matches for in the collection.
void	setFaceMatchThreshold(Float faceMatchThreshold) Optional value specifying the minimum confidence in the face match to return.
void	setMaxFaces(Integer maxFaces) Maximum number of faces to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchFacesRequest	withCollectionId(String collectionId) ID of the collection the face belongs to.
SearchFacesRequest	withFaceId(String faceId) ID of a face to find matches for in the collection.
SearchFacesRequest	withFaceMatchThreshold(Float faceMatchThreshold) Optional value specifying the minimum confidence in the face match to return.
SearchFacesRequest	withMaxFaces(Integer maxFaces) Maximum number of faces to return.

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

SearchFacesRequest

public SearchFacesRequest()

Method Detail

setCollectionId

public void setCollectionId(String collectionId)

ID of the collection the face belongs to.

Parameters:

collectionId - ID of the collection the face belongs to.

getCollectionId

public String getCollectionId()

ID of the collection the face belongs to.

Returns:

ID of the collection the face belongs to.

withCollectionId

public SearchFacesRequest withCollectionId(String collectionId)

ID of the collection the face belongs to.

Parameters:

collectionId - ID of the collection the face belongs to.

Returns:

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

setFaceId

public void setFaceId(String faceId)

ID of a face to find matches for in the collection.

Parameters:

faceId - ID of a face to find matches for in the collection.

getFaceId

public String getFaceId()

ID of a face to find matches for in the collection.

Returns:

ID of a face to find matches for in the collection.

withFaceId

public SearchFacesRequest withFaceId(String faceId)

ID of a face to find matches for in the collection.

Parameters:

faceId - ID of a face to find matches for in the collection.

Returns:

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

setMaxFaces

public void setMaxFaces(Integer maxFaces)

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Parameters:

maxFaces - Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

getMaxFaces

public Integer getMaxFaces()

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns:

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

withMaxFaces

public SearchFacesRequest withMaxFaces(Integer maxFaces)

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Parameters:

maxFaces - Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns:

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

setFaceMatchThreshold

public void setFaceMatchThreshold(Float faceMatchThreshold)

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Parameters:

faceMatchThreshold - Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

getFaceMatchThreshold

public Float getFaceMatchThreshold()

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Returns:

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

withFaceMatchThreshold

public SearchFacesRequest withFaceMatchThreshold(Float faceMatchThreshold)

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Parameters:

faceMatchThreshold - Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

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 SearchFacesRequest 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()