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

Class StartTextDetectionFilters

java.lang.Object

software.amazon.awssdk.services.rekognition.model.StartTextDetectionFilters

All Implemented Interfaces:

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

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

Set of optional parameters that let you set the criteria text must meet to be included in your response. WordFilter looks at a word's height, width and minimum confidence. RegionOfInterest lets you set a specific region of the screen to look for text in.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartTextDetectionFilters.Builder

Method Summary

Modifier and Type	Method	Description
static StartTextDetectionFilters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegionsOfInterest()	For responses, this returns true if the service returned a value for the RegionsOfInterest property.
List<RegionOfInterest>	regionsOfInterest()	Filter focusing on a certain area of the frame.
List<SdkField<?>>	sdkFields()
static Class<? extends StartTextDetectionFilters.Builder>	serializableBuilderClass()
StartTextDetectionFilters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DetectionFilter	wordFilter()	Filters focusing on qualities of the text, such as confidence or size.

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

wordFilter

public final DetectionFilter wordFilter()

Filters focusing on qualities of the text, such as confidence or size.

Returns:

Filters focusing on qualities of the text, such as confidence or size.

hasRegionsOfInterest

public final boolean hasRegionsOfInterest()

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

regionsOfInterest

public final List<RegionOfInterest> regionsOfInterest()

Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.

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

Returns:

Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.

toBuilder

public StartTextDetectionFilters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartTextDetectionFilters.Builder,StartTextDetectionFilters>

builder

public static StartTextDetectionFilters.Builder builder()

serializableBuilderClass

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