Query (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.textract.model.Query

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Query
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Each query contains the question you want to ask in the Text and the alias you want to associate.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Query()

Constructors
Constructor and Description
`Query()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Query`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlias()` Alias attached to the query, for ease of location.
`List<String>`	`getPages()` Pages is a parameter that the user inputs to specify which pages to apply a query to.
`String`	`getText()` Question that Amazon Textract will apply to the document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlias(String alias)` Alias attached to the query, for ease of location.
`void`	`setPages(Collection<String> pages)` Pages is a parameter that the user inputs to specify which pages to apply a query to.
`void`	`setText(String text)` Question that Amazon Textract will apply to the document.
`String`	`toString()` Returns a string representation of this object.
`Query`	`withAlias(String alias)` Alias attached to the query, for ease of location.
`Query`	`withPages(Collection<String> pages)` Pages is a parameter that the user inputs to specify which pages to apply a query to.
`Query`	`withPages(String... pages)` Pages is a parameter that the user inputs to specify which pages to apply a query to.
`Query`	`withText(String text)` Question that Amazon Textract will apply to the document.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Query
```
public Query()
```
- Method Detail
  - setText
```
public void setText(String text)
```
    Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
    
    Parameters:
    
    text - Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
  - getText
```
public String getText()
```
    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?"
  - withText
```
public Query withText(String text)
```
    Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
    
    Parameters:
    
    text - Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlias
```
public void setAlias(String alias)
```
    Alias attached to the query, for ease of location.
    
    Parameters:
    
    alias - Alias attached to the query, for ease of location.
  - getAlias
```
public String getAlias()
```
    Alias attached to the query, for ease of location.
    
    Returns:
    
    Alias attached to the query, for ease of location.
  - withAlias
```
public Query withAlias(String alias)
```
    Alias attached to the query, for ease of location.
    
    Parameters:
    
    alias - Alias attached to the query, for ease of location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPages
```
public List<String> getPages()
```
    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.
    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.
  - setPages
```
public void setPages(Collection<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.
    Parameters:
    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.
  - withPages
```
public Query withPages(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.
    NOTE: This method appends the values to the existing list (if any). Use setPages(java.util.Collection) or withPages(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPages
```
public Query withPages(Collection<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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Query clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Query

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Query

Method Detail

setText

getText

withText

setAlias

getAlias

withAlias

getPages

setPages

withPages

withPages

toString

equals

hashCode

clone

marshall