Celebrity (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rekognition.model.Celebrity

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Celebrity
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides information about a celebrity recognized by the operation.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Celebrity()

Constructors
Constructor and Description
`Celebrity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Celebrity`	`clone()`
`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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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
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.
    
    NOTE: This method appends the values to the existing list (if any). Use setUrls(java.util.Collection) or withUrls(java.util.Collection) if you want to override the existing values.
    
    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:
    
    Returns a reference to this 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the celebrity.
    
    Parameters:
    
    name - The name of the celebrity.
  - getName
```
public String getName()
```
    The name of the celebrity.
    
    Returns:
    
    The name of the celebrity.
  - withName
```
public Celebrity withName(String name)
```
    The name of the celebrity.
    
    Parameters:
    
    name - The name of the celebrity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the celebrity.
    
    Parameters:
    
    id - A unique identifier for the celebrity.
  - getId
```
public String getId()
```
    A unique identifier for the celebrity.
    
    Returns:
    
    A unique identifier for the celebrity.
  - withId
```
public Celebrity withId(String id)
```
    A unique identifier for the celebrity.
    
    Parameters:
    
    id - A unique identifier for the celebrity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withFace
```
public Celebrity withFace(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMatchConfidence
```
public void setMatchConfidence(Float matchConfidence)
```
    The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
    
    Parameters:
    
    matchConfidence - The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
  - getMatchConfidence
```
public Float getMatchConfidence()
```
    The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
    
    Returns:
    
    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.
    
    Parameters:
    
    matchConfidence - The confidence, in percentage, that Rekognition has that the recognized face is the celebrity.
    
    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 Celebrity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Celebrity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Celebrity

Method Detail

getUrls

setUrls

withUrls

withUrls

setName

getName

withName

setId

getId

withId

setFace

getFace

withFace

setMatchConfidence

getMatchConfidence

withMatchConfidence

toString

equals

hashCode

clone

marshall