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

Class RegionOfInterest

java.lang.Object

software.amazon.awssdk.services.rekognition.model.RegionOfInterest

All Implemented Interfaces:

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

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

Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox or Polygon to set a region of the screen.

A word, face, or label is included in the region if it is more than half in that region. If there is more than one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region is kept in the results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegionOfInterest.Builder

Method Summary

Modifier and Type	Method	Description
BoundingBox	boundingBox()	The box representing a region of interest on screen.
static RegionOfInterest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolygon()	For responses, this returns true if the service returned a value for the Polygon property.
List<Point>	polygon()	Specifies a shape made up of up to 10 Point objects to define a region of interest.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RegionOfInterest.Builder>	serializableBuilderClass()
RegionOfInterest.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 box representing a region of interest on screen.

Returns:

The box representing a region of interest on screen.

hasPolygon

public final boolean hasPolygon()

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

polygon

public final List<Point> polygon()

Specifies a shape made up of up to 10 Point objects to define a region of interest.

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

Returns:

Specifies a shape made up of up to 10 Point objects to define a region of interest.

toBuilder

public RegionOfInterest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegionOfInterest.Builder,RegionOfInterest>

builder

public static RegionOfInterest.Builder builder()

serializableBuilderClass

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