com.amazonaws.services.rekognition.model

Class Face

java.lang.Object

com.amazonaws.services.rekognition.model.Face

All Implemented Interfaces:

java.io.Serializable

public class Face
extends java.lang.Object
implements java.io.Serializable

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Face()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
BoundingBox	getBoundingBox() Bounding box of the face.
java.lang.Float	getConfidence() Confidence level that the bounding box contains a face (and not a different object such as a tree).
java.lang.String	getExternalImageId() Identifier that you assign to all the faces in the input image.
java.lang.String	getFaceId() Unique identifier that Amazon Rekognition assigns to the face.
java.lang.String	getImageId() Unique identifier that Amazon Rekognition assigns to the input image.
int	hashCode()
void	setBoundingBox(BoundingBox boundingBox) Bounding box of the face.
void	setConfidence(java.lang.Float confidence) Confidence level that the bounding box contains a face (and not a different object such as a tree).
void	setExternalImageId(java.lang.String externalImageId) Identifier that you assign to all the faces in the input image.
void	setFaceId(java.lang.String faceId) Unique identifier that Amazon Rekognition assigns to the face.
void	setImageId(java.lang.String imageId) Unique identifier that Amazon Rekognition assigns to the input image.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Face	withBoundingBox(BoundingBox boundingBox) Bounding box of the face.
Face	withConfidence(java.lang.Float confidence) Confidence level that the bounding box contains a face (and not a different object such as a tree).
Face	withExternalImageId(java.lang.String externalImageId) Identifier that you assign to all the faces in the input image.
Face	withFaceId(java.lang.String faceId) Unique identifier that Amazon Rekognition assigns to the face.
Face	withImageId(java.lang.String imageId) Unique identifier that Amazon Rekognition assigns to the input image.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Face

public Face()

Method Detail

getFaceId

public java.lang.String getFaceId()

Unique identifier that Amazon Rekognition assigns to the face.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Returns:

Unique identifier that Amazon Rekognition assigns to the face.

setFaceId

public void setFaceId(java.lang.String faceId)

Unique identifier that Amazon Rekognition assigns to the face.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Parameters:

faceId -

Unique identifier that Amazon Rekognition assigns to the face.

withFaceId

public Face withFaceId(java.lang.String faceId)

Unique identifier that Amazon Rekognition assigns to the face.

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

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Parameters:

faceId -

Unique identifier that Amazon Rekognition assigns to the face.

Returns:

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

getBoundingBox

public BoundingBox getBoundingBox()

Bounding box of the face.

Returns:

Bounding box of the face.

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox)

Bounding box of the face.

Parameters:

boundingBox -

Bounding box of the face.

withBoundingBox

public Face withBoundingBox(BoundingBox boundingBox)

Bounding box of the face.

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

Parameters:

boundingBox -

Bounding box of the face.

Returns:

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

getImageId

public java.lang.String getImageId()

Unique identifier that Amazon Rekognition assigns to the input image.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Returns:

Unique identifier that Amazon Rekognition assigns to the input image.

setImageId

public void setImageId(java.lang.String imageId)

Unique identifier that Amazon Rekognition assigns to the input image.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Parameters:

imageId -

Unique identifier that Amazon Rekognition assigns to the input image.

withImageId

public Face withImageId(java.lang.String imageId)

Unique identifier that Amazon Rekognition assigns to the input image.

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

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Parameters:

imageId -

Unique identifier that Amazon Rekognition assigns to the input image.

Returns:

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

getExternalImageId

public java.lang.String getExternalImageId()

Identifier that you assign to all the faces in the input image.

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

Returns:

Identifier that you assign to all the faces in the input image.

setExternalImageId

public void setExternalImageId(java.lang.String externalImageId)

Identifier that you assign to all the faces in the input image.

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

Parameters:

externalImageId -

Identifier that you assign to all the faces in the input image.

withExternalImageId

public Face withExternalImageId(java.lang.String externalImageId)

Identifier that you assign to all the faces in the input image.

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

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

Parameters:

externalImageId -

Identifier that you assign to all the faces in the input image.

Returns:

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

getConfidence

public java.lang.Float getConfidence()

Confidence level that the bounding box contains a face (and not a different object such as a tree).

Constraints:
Length: 0 - 100

Returns:

Confidence level that the bounding box contains a face (and not a different object such as a tree).

setConfidence

public void setConfidence(java.lang.Float confidence)

Confidence level that the bounding box contains a face (and not a different object such as a tree).

Constraints:
Length: 0 - 100

Parameters:

confidence -

Confidence level that the bounding box contains a face (and not a different object such as a tree).

withConfidence

public Face withConfidence(java.lang.Float confidence)

Confidence level that the bounding box contains a face (and not a different object such as a tree).

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

Constraints:
Length: 0 - 100

Parameters:

confidence -

Confidence level that the bounding box contains a face (and not a different object such as a tree).

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