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, detected instances, parent labels, and level of confidence.

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstances() Returns true if the Instances property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasParents() Returns true if the Parents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.

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

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.

hasInstances

public boolean hasInstances()

Returns true if the Instances property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

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

You can use hasInstances() to see if a value was sent in this field.

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.

hasParents

public boolean hasParents()

Returns true if the Parents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parents

public List<Parent> parents()

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

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

You can use hasParents() to see if a value was sent in this field.

Returns:

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

toBuilder

public Label.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Label.Builder,Label>

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

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo