Struct ProcessOptions 

#[non_exhaustive]
pub struct ProcessOptions {
    pub ocr_config: Option<OcrConfig>,
    pub layout_config: Option<LayoutConfig>,
    pub schema_override: Option<DocumentSchema>,
    pub page_range: Option<PageRange>,
    /* private fields */
}

Options for Process API

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ocr_config: Option<OcrConfig>

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

layout_config: Option<LayoutConfig>

Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

schema_override: Option<DocumentSchema>

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn’t support schema override.

page_range: Option<PageRange>

A subset of pages to process. If not specified, all pages are processed. If a page range is set, only the given pages are extracted and processed from the document. In the output document, Document.Page.page_number refers to the page number in the original document. This configuration only applies to online processing with ProcessDocument.

Implementations

impl ProcessOptions

pub fn new() -> Self

pub fn set_ocr_config<T>(self, v: T) -> Self

where T: Into<OcrConfig>,

Sets the value of ocr_config.

Example

use google_cloud_documentai_v1::model::OcrConfig;
let x = ProcessOptions::new().set_ocr_config(OcrConfig::default()/* use setters */);

pub fn set_or_clear_ocr_config<T>(self, v: Option<T>) -> Self

where T: Into<OcrConfig>,

Sets or clears the value of ocr_config.

Example

use google_cloud_documentai_v1::model::OcrConfig;
let x = ProcessOptions::new().set_or_clear_ocr_config(Some(OcrConfig::default()/* use setters */));
let x = ProcessOptions::new().set_or_clear_ocr_config(None::<OcrConfig>);

pub fn set_layout_config<T>(self, v: T) -> Self

where T: Into<LayoutConfig>,

Sets the value of layout_config.

Example

use google_cloud_documentai_v1::model::process_options::LayoutConfig;
let x = ProcessOptions::new().set_layout_config(LayoutConfig::default()/* use setters */);

pub fn set_or_clear_layout_config<T>(self, v: Option<T>) -> Self

where T: Into<LayoutConfig>,

Sets or clears the value of layout_config.

Example

use google_cloud_documentai_v1::model::process_options::LayoutConfig;
let x = ProcessOptions::new().set_or_clear_layout_config(Some(LayoutConfig::default()/* use setters */));
let x = ProcessOptions::new().set_or_clear_layout_config(None::<LayoutConfig>);

pub fn set_schema_override<T>(self, v: T) -> Self

where T: Into<DocumentSchema>,

Sets the value of schema_override.

Example

use google_cloud_documentai_v1::model::DocumentSchema;
let x = ProcessOptions::new().set_schema_override(DocumentSchema::default()/* use setters */);

pub fn set_or_clear_schema_override<T>(self, v: Option<T>) -> Self

where T: Into<DocumentSchema>,

Sets or clears the value of schema_override.

Example

use google_cloud_documentai_v1::model::DocumentSchema;
let x = ProcessOptions::new().set_or_clear_schema_override(Some(DocumentSchema::default()/* use setters */));
let x = ProcessOptions::new().set_or_clear_schema_override(None::<DocumentSchema>);

pub fn set_page_range<T: Into<Option<PageRange>>>(self, v: T) -> Self

Sets the value of page_range.

Note that all the setters affecting page_range are mutually exclusive.

Example

use google_cloud_documentai_v1::model::process_options::PageRange;
let x = ProcessOptions::new().set_page_range(Some(PageRange::FromStart(42)));

pub fn individual_page_selector(&self) -> Option<&Box<IndividualPageSelector>>

The value of page_range if it holds a IndividualPageSelector, None if the field is not set or holds a different branch.

pub fn set_individual_page_selector<T: Into<Box<IndividualPageSelector>>>( self, v: T, ) -> Self

Sets the value of page_range to hold a IndividualPageSelector.

Note that all the setters affecting page_range are mutually exclusive.

Example

use google_cloud_documentai_v1::model::process_options::IndividualPageSelector;
let x = ProcessOptions::new().set_individual_page_selector(IndividualPageSelector::default()/* use setters */);
assert!(x.individual_page_selector().is_some());
assert!(x.from_start().is_none());
assert!(x.from_end().is_none());

pub fn from_start(&self) -> Option<&i32>

The value of page_range if it holds a FromStart, None if the field is not set or holds a different branch.

pub fn set_from_start<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_range to hold a FromStart.

Note that all the setters affecting page_range are mutually exclusive.

Example

let x = ProcessOptions::new().set_from_start(42);
assert!(x.from_start().is_some());
assert!(x.individual_page_selector().is_none());
assert!(x.from_end().is_none());

pub fn from_end(&self) -> Option<&i32>

The value of page_range if it holds a FromEnd, None if the field is not set or holds a different branch.

pub fn set_from_end<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_range to hold a FromEnd.

Note that all the setters affecting page_range are mutually exclusive.

Example

let x = ProcessOptions::new().set_from_end(42);
assert!(x.from_end().is_some());
assert!(x.individual_page_selector().is_none());
assert!(x.from_start().is_none());

Trait Implementations

impl Clone for ProcessOptions

fn clone(&self) -> ProcessOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessOptions

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

Formats the value using the given formatter.

impl Default for ProcessOptions

fn default() -> ProcessOptions

Returns the “default value” for a type.

impl Message for ProcessOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ProcessOptions

fn eq(&self, other: &ProcessOptions) -> 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 ProcessOptions