Cloud Translation V3 Client - Class BatchTranslateMetadata (1.16.0)

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

State metadata for the batch translation operation.

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

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ state int

The state of the operation.

↳ translated_characters int|string

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

↳ failed_characters int|string

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

↳ total_characters int|string

Total number of characters (Unicode codepoints). This is the total number of codepoints from input files times the number of target languages and appears here shortly after the call is submitted.

↳ submit_time Google\Protobuf\Timestamp

Time when the operation was submitted.

getState

The state of the operation.

Returns
TypeDescription
int

setState

The state of the operation.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTranslatedCharacters

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

Returns
TypeDescription
int|string

setTranslatedCharacters

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getFailedCharacters

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

Returns
TypeDescription
int|string

setFailedCharacters

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTotalCharacters

Total number of characters (Unicode codepoints).

This is the total number of codepoints from input files times the number of target languages and appears here shortly after the call is submitted.

Returns
TypeDescription
int|string

setTotalCharacters

Total number of characters (Unicode codepoints).

This is the total number of codepoints from input files times the number of target languages and appears here shortly after the call is submitted.

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