Cloud Translation V3 Client - Class BatchTranslateDocumentResponse (2.0.3)

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

Stored in the google.longrunning.Operation.response field returned by BatchTranslateDocument if at least one document is translated successfully.

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

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ total_pages
int|string

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

↳ translated_pages
int|string

Number of successfully translated pages in all documents. 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. 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)

↳ total_characters
int|string

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

↳ translated_characters
int|string

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

↳ failed_characters
int|string

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

↳ total_billable_characters
int|string

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

↳ submit_time
Google\Protobuf\Timestamp

Time when the operation was submitted.

↳ end_time
Google\Protobuf\Timestamp

The time when the operation is finished and google.longrunning.Operation.done is set to true.

getTotalPages

Total number of pages to translate in all documents. 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. 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. 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. 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. 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. 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)

Returns
Type
Description
int|string

setTotalBillablePages

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

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

getTotalCharacters

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

Returns
Type
Description
int|string

setTotalCharacters

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

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

getTranslatedCharacters

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

Returns
Type
Description
int|string

setTranslatedCharacters

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

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

getFailedCharacters

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

Returns
Type
Description
int|string

setFailedCharacters

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

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.

Returns
Type
Description
int|string

setTotalBillableCharacters

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

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

getSubmitTime

Time when the operation was submitted.

Returns
Type
Description

hasSubmitTime

clearSubmitTime

setSubmitTime

Time when the operation was submitted.

Parameter
Name
Description
Returns
Type
Description
$this

getEndTime

The time when the operation is finished and google.longrunning.Operation.done is set to true.

Returns
Type
Description

hasEndTime

clearEndTime

setEndTime

The time when the operation is finished and google.longrunning.Operation.done is set to true.

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