Struct google_api_proto::google::cloud::documentai::v1::Processor

pub struct Processor {
    pub name: String,
    pub type: String,
    pub display_name: String,
    pub state: i32,
    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,
}

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

Fields

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][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].

display_name: String

The display name of the processor.

state: i32

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>

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 state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Processor

fn clone(&self) -> Processor

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for Processor

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Processor

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Processor