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

Interface Query.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Query.Builder,Query>, SdkBuilder<Query.Builder,Query>, SdkPojo
Enclosing class:
Query
public static interface Query.Builder extends SdkPojo, CopyableBuilder<Query.Builder,Query>

  • Method Details

    • text

      Query.Builder text(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.

    • alias

      Query.Builder alias(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.

    • pages

      Query.Builder pages(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.

    • pages

      Query.Builder pages(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.