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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
int | |
setState
The state of the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTranslatedCharacters
Number of successfully translated characters so far (Unicode codepoints).
| Returns | |
|---|---|
| Type | Description |
int|string | |
setTranslatedCharacters
Number of successfully translated characters so far (Unicode codepoints).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFailedCharacters
Number of characters that have failed to process so far (Unicode codepoints).
| Returns | |
|---|---|
| Type | Description |
int|string | |
setFailedCharacters
Number of characters that have failed to process so far (Unicode codepoints).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 | |