com.amazonaws.services.rekognition.model

Class Celebrity

java.lang.Object

com.amazonaws.services.rekognition.model.Celebrity

All Implemented Interfaces:

Serializable

public class Celebrity
extends Object
implements Serializable

Provides information about a celebrity recognized by the operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Celebrity()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ComparedFace	getFace() Provides information about the celebrity's face, such as its location on the image.
String	getId() A unique identifier for the celebrity.
Float	getMatchConfidence() The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
String	getName() The name of the celebrity.
List<String>	getUrls() An array of URLs pointing to additional information about the celebrity.
int	hashCode()
void	setFace(ComparedFace face) Provides information about the celebrity's face, such as its location on the image.
void	setId(String id) A unique identifier for the celebrity.
void	setMatchConfidence(Float matchConfidence) The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
void	setName(String name) The name of the celebrity.
void	setUrls(Collection<String> urls) An array of URLs pointing to additional information about the celebrity.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Celebrity	withFace(ComparedFace face) Provides information about the celebrity's face, such as its location on the image.
Celebrity	withId(String id) A unique identifier for the celebrity.
Celebrity	withMatchConfidence(Float matchConfidence) The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
Celebrity	withName(String name) The name of the celebrity.
Celebrity	withUrls(Collection<String> urls) An array of URLs pointing to additional information about the celebrity.
Celebrity	withUrls(String... urls) An array of URLs pointing to additional information about the celebrity.

Methods inherited from class java.lang.Object

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

Constructor Detail

Celebrity

public Celebrity()

Method Detail

getUrls

public List<String> getUrls()

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

Returns:

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

setUrls

public void setUrls(Collection<String> urls)

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

Parameters:

urls -

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

withUrls

public Celebrity withUrls(String... urls)

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

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

Parameters:

urls -

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

Returns:

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

withUrls

public Celebrity withUrls(Collection<String> urls)

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

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

Parameters:

urls -

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

Returns:

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

getName

public String getName()

The name of the celebrity.

Returns:

The name of the celebrity.

setName

public void setName(String name)

The name of the celebrity.

Parameters:

name -

The name of the celebrity.

withName

public Celebrity withName(String name)

The name of the celebrity.

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

Parameters:

name -

The name of the celebrity.

Returns:

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

getId

public String getId()

A unique identifier for the celebrity.

Constraints:
Pattern: [0-9A-Za-z]*

Returns:

A unique identifier for the celebrity.

setId

public void setId(String id)

A unique identifier for the celebrity.

Constraints:
Pattern: [0-9A-Za-z]*

Parameters:

id -

A unique identifier for the celebrity.

withId

public Celebrity withId(String id)

A unique identifier for the celebrity.

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

Constraints:
Pattern: [0-9A-Za-z]*

Parameters:

id -

A unique identifier for the celebrity.

Returns:

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

getFace

public ComparedFace getFace()

Provides information about the celebrity's face, such as its location on the image.

Returns:

Provides information about the celebrity's face, such as its location on the image.

setFace

public void setFace(ComparedFace face)

Provides information about the celebrity's face, such as its location on the image.

Parameters:

face -

Provides information about the celebrity's face, such as its location on the image.

withFace

public Celebrity withFace(ComparedFace face)

Provides information about the celebrity's face, such as its location on the image.

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

Parameters:

face -

Provides information about the celebrity's face, such as its location on the image.

Returns:

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

getMatchConfidence

public Float getMatchConfidence()

The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

Constraints:
Length: 0 - 100

Returns:

The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

setMatchConfidence

public void setMatchConfidence(Float matchConfidence)

The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

Constraints:
Length: 0 - 100

Parameters:

matchConfidence -

The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

withMatchConfidence

public Celebrity withMatchConfidence(Float matchConfidence)

The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

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

Constraints:
Length: 0 - 100

Parameters:

matchConfidence -

The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object