Cloud Translation V3 Client - Class BatchTranslateResponse (1.18.0)

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

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name Description
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
Type Description
int|string

setTotalCharacters

Total number of characters (Unicode codepoints).

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

getTranslatedCharacters

Number of successfully translated characters (Unicode codepoints).

Returns
Type Description
int|string

setTranslatedCharacters

Number of successfully translated characters (Unicode codepoints).

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

getFailedCharacters

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

Returns
Type Description
int|string

setFailedCharacters

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

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

getEndTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

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