com.amazonaws.services.rekognition.model

Class SearchFacesByImageResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.rekognition.model.SearchFacesByImageResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchFacesByImageResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchFacesByImageResult()

Method Summary

Modifier and Type	Method and Description
SearchFacesByImageResult	clone()
boolean	equals(Object obj)
List<FaceMatch>	getFaceMatches() An array of faces that match the input face, along with the confidence in the match.
String	getFaceModelVersion() Version number of the face detection model associated with the input collection (CollectionId).
BoundingBox	getSearchedFaceBoundingBox() The bounding box around the face in the input image that Amazon Rekognition used for the search.
Float	getSearchedFaceConfidence() The level of confidence that the searchedFaceBoundingBox, contains a face.
int	hashCode()
void	setFaceMatches(Collection<FaceMatch> faceMatches) An array of faces that match the input face, along with the confidence in the match.
void	setFaceModelVersion(String faceModelVersion) Version number of the face detection model associated with the input collection (CollectionId).
void	setSearchedFaceBoundingBox(BoundingBox searchedFaceBoundingBox) The bounding box around the face in the input image that Amazon Rekognition used for the search.
void	setSearchedFaceConfidence(Float searchedFaceConfidence) The level of confidence that the searchedFaceBoundingBox, contains a face.
String	toString() Returns a string representation of this object.
SearchFacesByImageResult	withFaceMatches(Collection<FaceMatch> faceMatches) An array of faces that match the input face, along with the confidence in the match.
SearchFacesByImageResult	withFaceMatches(FaceMatch... faceMatches) An array of faces that match the input face, along with the confidence in the match.
SearchFacesByImageResult	withFaceModelVersion(String faceModelVersion) Version number of the face detection model associated with the input collection (CollectionId).
SearchFacesByImageResult	withSearchedFaceBoundingBox(BoundingBox searchedFaceBoundingBox) The bounding box around the face in the input image that Amazon Rekognition used for the search.
SearchFacesByImageResult	withSearchedFaceConfidence(Float searchedFaceConfidence) The level of confidence that the searchedFaceBoundingBox, contains a face.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchFacesByImageResult

public SearchFacesByImageResult()

Method Detail

setSearchedFaceBoundingBox

public void setSearchedFaceBoundingBox(BoundingBox searchedFaceBoundingBox)

The bounding box around the face in the input image that Amazon Rekognition used for the search.

Parameters:

searchedFaceBoundingBox - The bounding box around the face in the input image that Amazon Rekognition used for the search.

getSearchedFaceBoundingBox

public BoundingBox getSearchedFaceBoundingBox()

The bounding box around the face in the input image that Amazon Rekognition used for the search.

Returns:

The bounding box around the face in the input image that Amazon Rekognition used for the search.

withSearchedFaceBoundingBox

public SearchFacesByImageResult withSearchedFaceBoundingBox(BoundingBox searchedFaceBoundingBox)

The bounding box around the face in the input image that Amazon Rekognition used for the search.

Parameters:

searchedFaceBoundingBox - The bounding box around the face in the input image that Amazon Rekognition used for the search.

Returns:

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

setSearchedFaceConfidence

public void setSearchedFaceConfidence(Float searchedFaceConfidence)

The level of confidence that the searchedFaceBoundingBox, contains a face.

Parameters:

searchedFaceConfidence - The level of confidence that the searchedFaceBoundingBox, contains a face.

getSearchedFaceConfidence

public Float getSearchedFaceConfidence()

The level of confidence that the searchedFaceBoundingBox, contains a face.

Returns:

The level of confidence that the searchedFaceBoundingBox, contains a face.

withSearchedFaceConfidence

public SearchFacesByImageResult withSearchedFaceConfidence(Float searchedFaceConfidence)

The level of confidence that the searchedFaceBoundingBox, contains a face.

Parameters:

searchedFaceConfidence - The level of confidence that the searchedFaceBoundingBox, contains a face.

Returns:

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

getFaceMatches

public List<FaceMatch> getFaceMatches()

An array of faces that match the input face, along with the confidence in the match.

Returns:

An array of faces that match the input face, along with the confidence in the match.

setFaceMatches

public void setFaceMatches(Collection<FaceMatch> faceMatches)

An array of faces that match the input face, along with the confidence in the match.

Parameters:

faceMatches - An array of faces that match the input face, along with the confidence in the match.

withFaceMatches

public SearchFacesByImageResult withFaceMatches(FaceMatch... faceMatches)

An array of faces that match the input face, along with the confidence in the match.

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

Parameters:

faceMatches - An array of faces that match the input face, along with the confidence in the match.

Returns:

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

withFaceMatches

public SearchFacesByImageResult withFaceMatches(Collection<FaceMatch> faceMatches)

An array of faces that match the input face, along with the confidence in the match.

Parameters:

faceMatches - An array of faces that match the input face, along with the confidence in the match.

Returns:

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

setFaceModelVersion

public void setFaceModelVersion(String faceModelVersion)

Version number of the face detection model associated with the input collection (CollectionId).

Parameters:

faceModelVersion - Version number of the face detection model associated with the input collection (CollectionId ).

getFaceModelVersion

public String getFaceModelVersion()

Version number of the face detection model associated with the input collection (CollectionId).

Returns:

Version number of the face detection model associated with the input collection ( CollectionId).

withFaceModelVersion

public SearchFacesByImageResult withFaceModelVersion(String faceModelVersion)

Version number of the face detection model associated with the input collection (CollectionId).

Parameters:

faceModelVersion - Version number of the face detection model associated with the input collection (CollectionId ).

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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

Overrides:

clone in class Object