Cloud Translation V3 Client - Class BatchTranslateDocumentMetadata (2.0.3)

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

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.

The state of the operation.

Returns
Type
Description
int

The state of the operation.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

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

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

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

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

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

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

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

Returns
Type
Description
int|string

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

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

Returns
Type
Description
int|string

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

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

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

Returns
Type
Description
int|string

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

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

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

Returns
Type
Description
int|string

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

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

Returns
Type
Description
int|string

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

Time when the operation was submitted.

Returns
Type
Description

Time when the operation was submitted.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: