Struct aws_sdk_textract::types::builders::QueryBuilder

#[non_exhaustive]
pub struct QueryBuilder { /* private fields */ }

A builder for Query.

Implementations

impl QueryBuilder

pub fn text(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_text(self, input: Option<String>) -> Self

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

pub fn get_text(&self) -> &Option<String>

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

pub fn alias(self, input: impl Into<String>) -> Self

Alias attached to the query, for ease of location.

pub fn set_alias(self, input: Option<String>) -> Self

Alias attached to the query, for ease of location.

pub fn get_alias(&self) -> &Option<String>

Alias attached to the query, for ease of location.

pub fn pages(self, input: impl Into<String>) -> Self

Appends an item to pages.

To override the contents of this collection use set_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.

pub fn set_pages(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_pages(&self) -> &Option<Vec<String>>

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.

pub fn build(self) -> Result<Query, BuildError>

Consumes the builder and constructs a Query. This method will fail if any of the following fields are not set:

• text

Trait Implementations

impl Clone for QueryBuilder

fn clone(&self) -> QueryBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryBuilder

fn default() -> QueryBuilder

Returns the “default value” for a type.

impl PartialEq for QueryBuilder

fn eq(&self, other: &QueryBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryBuilder