Cloud Translation V3 Client - Class BatchTranslateResponse (1.13.3)

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

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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ total_characters int|string

Total number of characters (Unicode codepoints).

↳ translated_characters int|string

Number of successfully translated characters (Unicode codepoints).

↳ failed_characters int|string

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

↳ 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.

getTotalCharacters

Total number of characters (Unicode codepoints).

Returns
TypeDescription
int|string

setTotalCharacters

Total number of characters (Unicode codepoints).

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTranslatedCharacters

Number of successfully translated characters (Unicode codepoints).

Returns
TypeDescription
int|string

setTranslatedCharacters

Number of successfully translated characters (Unicode codepoints).

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getFailedCharacters

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

Returns
TypeDescription
int|string

setFailedCharacters

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

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