Cloud Translation V3 Client - Class BatchTranslateDocumentResponse (1.12.12)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
int|string

setTotalPages

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTranslatedPages

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

Returns
TypeDescription
int|string

setTranslatedPages

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getFailedPages

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

Returns
TypeDescription
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
NameDescription
var int|string
Returns
TypeDescription
$this

getTotalBillablePages

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

Returns
TypeDescription
int|string

setTotalBillablePages

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTotalCharacters

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

Returns
TypeDescription
int|string

setTotalCharacters

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTranslatedCharacters

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

Returns
TypeDescription
int|string

setTranslatedCharacters

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getFailedCharacters

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

Returns
TypeDescription
int|string

setFailedCharacters

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTotalBillableCharacters

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

Returns
TypeDescription
int|string

setTotalBillableCharacters

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getSubmitTime

Time when the operation was submitted.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasSubmitTime

clearSubmitTime

setSubmitTime

Time when the operation was submitted.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this