Struct BatchTranslateDocumentMetadata 

#[non_exhaustive]
pub struct BatchTranslateDocumentMetadata {
    pub state: State,
    pub total_pages: i64,
    pub translated_pages: i64,
    pub failed_pages: i64,
    pub total_billable_pages: i64,
    pub total_characters: i64,
    pub translated_characters: i64,
    pub failed_characters: i64,
    pub total_billable_characters: i64,
    pub submit_time: Option<Timestamp>,
    /* private fields */
}

State metadata for the batch translation operation.

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.

state: State

The state of the operation.

total_pages: i64

Total number of pages to translate in all documents so far. Documents without clear page definition (such as XLSX) are not counted.

translated_pages: i64

Number of successfully translated pages in all documents so far. Documents without clear page definition (such as XLSX) are not counted.

failed_pages: i64

Number of pages that failed to process in all documents so far. Documents without clear page definition (such as XLSX) are not counted.

total_billable_pages: i64

Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.

total_characters: i64

Total number of characters (Unicode codepoints) in all documents so far.

translated_characters: i64

Number of successfully translated characters (Unicode codepoints) in all documents so far.

failed_characters: i64

Number of characters that have failed to process (Unicode codepoints) in all documents so far.

total_billable_characters: i64

Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.

submit_time: Option<Timestamp>

Time when the operation was submitted.

Implementations

impl BatchTranslateDocumentMetadata

pub fn new() -> Self

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

Sets the value of state.

Example

use google_cloud_translation_v3::model::batch_translate_document_metadata::State;
let x0 = BatchTranslateDocumentMetadata::new().set_state(State::Running);
let x1 = BatchTranslateDocumentMetadata::new().set_state(State::Succeeded);
let x2 = BatchTranslateDocumentMetadata::new().set_state(State::Failed);

pub fn set_total_pages<T: Into<i64>>(self, v: T) -> Self

Sets the value of total_pages.

Example

let x = BatchTranslateDocumentMetadata::new().set_total_pages(42);

pub fn set_translated_pages<T: Into<i64>>(self, v: T) -> Self

Sets the value of translated_pages.

Example

let x = BatchTranslateDocumentMetadata::new().set_translated_pages(42);

pub fn set_failed_pages<T: Into<i64>>(self, v: T) -> Self

Sets the value of failed_pages.

Example

let x = BatchTranslateDocumentMetadata::new().set_failed_pages(42);

pub fn set_total_billable_pages<T: Into<i64>>(self, v: T) -> Self

Sets the value of total_billable_pages.

Example

let x = BatchTranslateDocumentMetadata::new().set_total_billable_pages(42);

pub fn set_total_characters<T: Into<i64>>(self, v: T) -> Self

Sets the value of total_characters.

Example

let x = BatchTranslateDocumentMetadata::new().set_total_characters(42);

pub fn set_translated_characters<T: Into<i64>>(self, v: T) -> Self

Sets the value of translated_characters.

Example

let x = BatchTranslateDocumentMetadata::new().set_translated_characters(42);

pub fn set_failed_characters<T: Into<i64>>(self, v: T) -> Self

Sets the value of failed_characters.

Example

let x = BatchTranslateDocumentMetadata::new().set_failed_characters(42);

pub fn set_total_billable_characters<T: Into<i64>>(self, v: T) -> Self

Sets the value of total_billable_characters.

Example

let x = BatchTranslateDocumentMetadata::new().set_total_billable_characters(42);

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

where T: Into<Timestamp>,

Sets the value of submit_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of submit_time.

Example

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

Trait Implementations

impl Clone for BatchTranslateDocumentMetadata

fn clone(&self) -> BatchTranslateDocumentMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchTranslateDocumentMetadata

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

Formats the value using the given formatter.

impl Default for BatchTranslateDocumentMetadata

fn default() -> BatchTranslateDocumentMetadata

Returns the “default value” for a type.

impl Message for BatchTranslateDocumentMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BatchTranslateDocumentMetadata

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