Cloud Translation V3 Client - Class BatchTranslateDocumentMetadata (1.18.0)

Reference documentation and code samples for the Cloud Translation V3 Client class BatchTranslateDocumentMetadata.

State metadata for the batch translation operation.

Generated from protobuf message google.cloud.translation.v3.BatchTranslateDocumentMetadata

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ state int

The state of the operation.

↳ total_pages int|string

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

↳ translated_pages int|string

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

↳ failed_pages int|string

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 int|string

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

↳ total_characters int|string

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

↳ translated_characters int|string

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

↳ failed_characters int|string

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

↳ total_billable_characters int|string

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

↳ submit_time Google\Protobuf\Timestamp

Time when the operation was submitted.

getState

The state of the operation.

Returns
Type Description
int

setState

The state of the operation.

Parameter
Name Description
var int
Returns
Type Description
$this

getTotalPages

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

Returns
Type Description
int|string

setTotalPages

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTranslatedPages

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

Returns
Type Description
int|string

setTranslatedPages

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getFailedPages

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

Returns
Type Description
int|string

setFailedPages

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTotalBillablePages

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

Returns
Type Description
int|string

setTotalBillablePages

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTotalCharacters

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

Returns
Type Description
int|string

setTotalCharacters

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTranslatedCharacters

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

Returns
Type Description
int|string

setTranslatedCharacters

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getFailedCharacters

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

Returns
Type Description
int|string

setFailedCharacters

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getTotalBillableCharacters

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

Returns
Type Description
int|string

setTotalBillableCharacters

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getSubmitTime

Time when the operation was submitted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasSubmitTime

clearSubmitTime

setSubmitTime

Time when the operation was submitted.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this