Package software.amazon.awssdk.services.textract.model

Class Query

java.lang.Object

software.amazon.awssdk.services.textract.model.Query

All Implemented Interfaces:

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

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

Each query contains the question you want to ask in the Text and the alias you want to associate.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Query.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	Alias attached to the query, for ease of location.
static Query.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPages()	For responses, this returns true if the service returned a value for the Pages property.
List<String>	pages()	Pages is a parameter that the user inputs to specify which pages to apply a query to.
List<SdkField<?>>	sdkFields()
static Class<? extends Query.Builder>	serializableBuilderClass()
String	text()	Question that Amazon Textract will apply to the document.
Query.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

text

public final String text()

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

Returns:

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

alias

public final String alias()

Alias attached to the query, for ease of location.

Returns:

Alias attached to the query, for ease of location.

hasPages

public final boolean hasPages()

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

pages

public final List<String> pages()

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to ["1"] by default.

• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

• When using * to indicate all pages, it must be the only element in the list.

• You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.

• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

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

Returns:

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to ["1"] by default.

• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

• When using * to indicate all pages, it must be the only element in the list.

• You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.

• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

toBuilder

public Query.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Query.Builder,Query>

builder

public static Query.Builder builder()

serializableBuilderClass

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