Package software.amazon.awssdk.services.rekognition.model

Class Celebrity

java.lang.Object

software.amazon.awssdk.services.rekognition.model.Celebrity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Celebrity.Builder,Celebrity>

@Generated("software.amazon.awssdk:codegen")
public final class Celebrity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Celebrity.Builder,Celebrity>

Provides information about a celebrity recognized by the RecognizeCelebrities operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Celebrity.Builder

Method Summary

Modifier and Type	Method	Description
static Celebrity.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ComparedFace	face()	Provides information about the celebrity's face, such as its location on the image.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUrls()	For responses, this returns true if the service returned a value for the Urls property.
String	id()	A unique identifier for the celebrity.
KnownGender	knownGender()	Returns the value of the KnownGender property for this object.
Float	matchConfidence()	The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
String	name()	The name of the celebrity.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Celebrity.Builder>	serializableBuilderClass()
Celebrity.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasUrls

public final boolean hasUrls()

For responses, this returns true if the service returned a value for the Urls property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

urls

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUrls() method.

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.

name

public final String name()

The name of the celebrity.

Returns:

The name of the celebrity.

id

public final String id()

A unique identifier for the celebrity.

Returns:

A unique identifier for the celebrity.

face

public final ComparedFace face()

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.

matchConfidence

public final Float matchConfidence()

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

Returns:

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

knownGender

public final KnownGender knownGender()

Returns the value of the KnownGender property for this object.

Returns:

The value of the KnownGender property for this object.

toBuilder

public Celebrity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Celebrity.Builder,Celebrity>

builder

public static Celebrity.Builder builder()

serializableBuilderClass

public static Class<? extends Celebrity.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo