software.amazon.awssdk.services.rekognition.model

Class Label

java.lang.Object

software.amazon.awssdk.services.rekognition.model.Label

All Implemented Interfaces:

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

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

Structure containing details about the detected label, including the name, and level of confidence.

The Amazon Rekognition Image operation operation returns a hierarchical taxonomy (Parents) for detected labels and also bounding box information (Instances) for detected labels. Amazon Rekognition Video doesn't return this information and returns null for the Parents and Instances attributes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Label.Builder

Method Summary

Modifier and Type	Method and Description
static Label.Builder	builder()
Float	confidence() Level of confidence.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<Instance>	instances() If Label represents an object, Instances contains the bounding boxes for each instance of the detected object.
String	name() The name (label) of the object or scene.
List<Parent>	parents() The parent labels for a label.
List<SdkField<?>>	sdkFields()
static Class<? extends Label.Builder>	serializableBuilderClass()
Label.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public String name()

The name (label) of the object or scene.

Returns:

The name (label) of the object or scene.

confidence

public Float confidence()

Level of confidence.

Returns:

Level of confidence.

instances

public List<Instance> instances()

If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.

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

Returns:

If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.

parents

public List<Parent> parents()

The parent labels for a label. The response includes all ancestor labels.

Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.

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

Returns:

The parent labels for a label. The response includes all ancestor labels.

Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.

toBuilder

public Label.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Label.Builder,Label>

Returns:

a builder for type T

builder

public static Label.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.