Struct ProcessorVersion 

#[non_exhaustive]
pub struct ProcessorVersion {

    pub name: String,
    pub display_name: String,
    pub document_schema: Option<DocumentSchema>,
    pub state: State,
    pub create_time: Option<Timestamp>,
    pub latest_evaluation: Option<EvaluationReference>,
    pub kms_key_name: String,
    pub kms_key_version_name: String,
    pub google_managed: bool,
    pub deprecation_info: Option<DeprecationInfo>,
    pub model_type: ModelType,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    pub gen_ai_model_info: Option<GenAiModelInfo>,
    /* private fields */
}

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

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

Identifier. The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

display_name: String

The display name of the processor version.

document_schema: Option<DocumentSchema>

Output only. The schema of the processor version. Describes the output.

state: State

Output only. The state of the processor version.

create_time: Option<Timestamp>

Output only. The time the processor version was created.

latest_evaluation: Option<EvaluationReference>

Output only. The most recently invoked evaluation for the processor version.

kms_key_name: String

Output only. The KMS key name used for encryption.

kms_key_version_name: String

Output only. The KMS key version with which data is encrypted.

google_managed: bool

Output only. Denotes that this ProcessorVersion is managed by Google.

deprecation_info: Option<DeprecationInfo>

Output only. If set, information about the eventual deprecation of this version.

model_type: ModelType

Output only. The model type of this processor version.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

gen_ai_model_info: Option<GenAiModelInfo>

Output only. Information about Generative AI model-based processor versions.

Implementations

impl ProcessorVersion

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 = ProcessorVersion::new().set_name(format!("projects/{project_id}/locations/{location_id}/processors/{processor_id}/processorVersions/{processor_version_id}"));

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

Sets the value of display_name.

Example

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

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

where T: Into<DocumentSchema>,

Sets the value of document_schema.

Example

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

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

where T: Into<DocumentSchema>,

Sets or clears the value of document_schema.

Example

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

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

Sets the value of state.

Example

use google_cloud_documentai_v1::model::processor_version::State;
let x0 = ProcessorVersion::new().set_state(State::Deployed);
let x1 = ProcessorVersion::new().set_state(State::Deploying);
let x2 = ProcessorVersion::new().set_state(State::Undeployed);

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 = ProcessorVersion::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 = ProcessorVersion::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = ProcessorVersion::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<EvaluationReference>,

Sets the value of latest_evaluation.

Example

use google_cloud_documentai_v1::model::EvaluationReference;
let x = ProcessorVersion::new().set_latest_evaluation(EvaluationReference::default()/* use setters */);

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

where T: Into<EvaluationReference>,

Sets or clears the value of latest_evaluation.

Example

use google_cloud_documentai_v1::model::EvaluationReference;
let x = ProcessorVersion::new().set_or_clear_latest_evaluation(Some(EvaluationReference::default()/* use setters */));
let x = ProcessorVersion::new().set_or_clear_latest_evaluation(None::<EvaluationReference>);

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

Sets the value of kms_key_name.

Example

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

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

Sets the value of kms_key_version_name.

Example

let x = ProcessorVersion::new().set_kms_key_version_name("example");

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

Sets the value of google_managed.

Example

let x = ProcessorVersion::new().set_google_managed(true);

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

where T: Into<DeprecationInfo>,

Sets the value of deprecation_info.

Example

use google_cloud_documentai_v1::model::processor_version::DeprecationInfo;
let x = ProcessorVersion::new().set_deprecation_info(DeprecationInfo::default()/* use setters */);

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

where T: Into<DeprecationInfo>,

Sets or clears the value of deprecation_info.

Example

use google_cloud_documentai_v1::model::processor_version::DeprecationInfo;
let x = ProcessorVersion::new().set_or_clear_deprecation_info(Some(DeprecationInfo::default()/* use setters */));
let x = ProcessorVersion::new().set_or_clear_deprecation_info(None::<DeprecationInfo>);

pub fn set_model_type<T: Into<ModelType>>(self, v: T) -> Self

Sets the value of model_type.

Example

use google_cloud_documentai_v1::model::processor_version::ModelType;
let x0 = ProcessorVersion::new().set_model_type(ModelType::Generative);
let x1 = ProcessorVersion::new().set_model_type(ModelType::Custom);

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

Sets the value of satisfies_pzs.

Example

let x = ProcessorVersion::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 = ProcessorVersion::new().set_satisfies_pzi(true);

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

where T: Into<GenAiModelInfo>,

Sets the value of gen_ai_model_info.

Example

use google_cloud_documentai_v1::model::processor_version::GenAiModelInfo;
let x = ProcessorVersion::new().set_gen_ai_model_info(GenAiModelInfo::default()/* use setters */);

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

where T: Into<GenAiModelInfo>,

Sets or clears the value of gen_ai_model_info.

Example

use google_cloud_documentai_v1::model::processor_version::GenAiModelInfo;
let x = ProcessorVersion::new().set_or_clear_gen_ai_model_info(Some(GenAiModelInfo::default()/* use setters */));
let x = ProcessorVersion::new().set_or_clear_gen_ai_model_info(None::<GenAiModelInfo>);

Trait Implementations

impl Clone for ProcessorVersion

fn clone(&self) -> ProcessorVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessorVersion

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

Formats the value using the given formatter.

impl Default for ProcessorVersion

fn default() -> ProcessorVersion

Returns the “default value” for a type.

impl Message for ProcessorVersion

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ProcessorVersion

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProcessorVersion