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

Class Instance

java.lang.Object

software.amazon.awssdk.services.rekognition.model.Instance

All Implemented Interfaces:

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

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

An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Instance.Builder

Method Summary

Modifier and Type	Method	Description
BoundingBox	boundingBox()	The position of the label instance on the image.
static Instance.Builder	builder()
Float	confidence()	The confidence that Amazon Rekognition has in the accuracy of the bounding box.
List<DominantColor>	dominantColors()	The dominant colors found in an individual instance of a label.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDominantColors()	For responses, this returns true if the service returned a value for the DominantColors property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Instance.Builder>	serializableBuilderClass()
Instance.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

boundingBox

public final BoundingBox boundingBox()

The position of the label instance on the image.

Returns:

The position of the label instance on the image.

confidence

public final Float confidence()

The confidence that Amazon Rekognition has in the accuracy of the bounding box.

Returns:

The confidence that Amazon Rekognition has in the accuracy of the bounding box.

hasDominantColors

public final boolean hasDominantColors()

For responses, this returns true if the service returned a value for the DominantColors 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.

dominantColors

public final List<DominantColor> dominantColors()

The dominant colors found in an individual instance of a label.

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 hasDominantColors() method.

Returns:

The dominant colors found in an individual instance of a label.

toBuilder

public Instance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>

builder

public static Instance.Builder builder()

serializableBuilderClass

public static Class<? extends Instance.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