Struct Processor 

#[non_exhaustive]
pub struct Processor {
    pub name: String,
    pub type: String,
    pub display_name: String,
    pub state: State,
    pub default_processor_version: String,
    pub processor_version_aliases: Vec<ProcessorVersionAlias>,
    pub process_endpoint: String,
    pub create_time: Option<Timestamp>,
    pub kms_key_name: String,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

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.

name: String

Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}

type: String

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

display_name: String

The display name of the processor.

state: State

Output only. The state of the processor.

default_processor_version: String

The default processor version.

processor_version_aliases: Vec<ProcessorVersionAlias>

Output only. The processor version aliases.

process_endpoint: String

Output only. Immutable. The http endpoint that can be called to invoke processing.

create_time: Option<Timestamp>

Output only. The time the processor was created.

kms_key_name: String

The KMS key used for encryption and decryption in CMEK scenarios.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl Processor

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Processor::new().set_name(format!("projects/{project_id}/locations/{location_id}/processors/{processor_id}"));

pub fn set_type<T: Into<String>>(self, v: T) -> Self

Sets the value of r#type.

Example

let x = Processor::new().set_type("example");

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = Processor::new().set_display_name("example");

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_documentai_v1::model::processor::State;
let x0 = Processor::new().set_state(State::Enabled);
let x1 = Processor::new().set_state(State::Disabled);
let x2 = Processor::new().set_state(State::Enabling);

pub fn set_default_processor_version<T: Into<String>>(self, v: T) -> Self

Sets the value of default_processor_version.

Example

let x = Processor::new().set_default_processor_version(format!("projects/{project_id}/locations/{location_id}/processors/{processor_id}/processorVersions/{processor_version_id}"));

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

where T: IntoIterator<Item = V>, V: Into<ProcessorVersionAlias>,

Sets the value of processor_version_aliases.

Example

use google_cloud_documentai_v1::model::ProcessorVersionAlias;
let x = Processor::new()
    .set_processor_version_aliases([
        ProcessorVersionAlias::default()/* use setters */,
        ProcessorVersionAlias::default()/* use (different) setters */,
    ]);

pub fn set_process_endpoint<T: Into<String>>(self, v: T) -> Self

Sets the value of process_endpoint.

Example

let x = Processor::new().set_process_endpoint("example");

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Processor::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Processor::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Processor::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_kms_key_name<T: Into<String>>(self, v: T) -> Self

Sets the value of kms_key_name.

Example

let x = Processor::new().set_kms_key_name("example");

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

Example

let x = Processor::new().set_satisfies_pzs(true);

pub fn set_satisfies_pzi<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzi.

Example

let x = Processor::new().set_satisfies_pzi(true);

Trait Implementations

impl Clone for Processor

fn clone(&self) -> Processor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Processor

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

Formats the value using the given formatter.

impl Default for Processor

fn default() -> Processor

Returns the “default value” for a type.

impl Message for Processor

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Processor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Processor