com.google.cloud.translate.v3

Interface BatchTranslateDocumentMetadataOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

BatchTranslateDocumentMetadata, BatchTranslateDocumentMetadata.Builder

public interface BatchTranslateDocumentMetadataOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
long	getFailedCharacters() Number of characters that have failed to process (Unicode codepoints) in all documents so far.
long	getFailedPages() Number of pages that failed to process in all documents so far.
BatchTranslateDocumentMetadata.State	getState() The state of the operation.
int	getStateValue() The state of the operation.
Timestamp	getSubmitTime() Time when the operation was submitted.
TimestampOrBuilder	getSubmitTimeOrBuilder() Time when the operation was submitted.
long	getTotalBillableCharacters() Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
long	getTotalBillablePages() Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
long	getTotalCharacters() Total number of characters (Unicode codepoints) in all documents so far.
long	getTotalPages() Total number of pages to translate in all documents so far.
long	getTranslatedCharacters() Number of successfully translated characters (Unicode codepoints) in all documents so far.
long	getTranslatedPages() Number of successfully translated pages in all documents so far.
boolean	hasSubmitTime() Time when the operation was submitted.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getStateValue

int getStateValue()

 The state of the operation.
 

.google.cloud.translation.v3.BatchTranslateDocumentMetadata.State state = 1;

Returns:

The enum numeric value on the wire for state.

getState

BatchTranslateDocumentMetadata.State getState()

 The state of the operation.
 

.google.cloud.translation.v3.BatchTranslateDocumentMetadata.State state = 1;

Returns:

The state.

getTotalPages

long getTotalPages()

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

int64 total_pages = 2;

Returns:

The totalPages.

getTranslatedPages

long getTranslatedPages()

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

int64 translated_pages = 3;

Returns:

The translatedPages.

getFailedPages

long getFailedPages()

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

int64 failed_pages = 4;

Returns:

The failedPages.

getTotalBillablePages

long getTotalBillablePages()

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

int64 total_billable_pages = 5;

Returns:

The totalBillablePages.

getTotalCharacters

long getTotalCharacters()

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

int64 total_characters = 6;

Returns:

The totalCharacters.

getTranslatedCharacters

long getTranslatedCharacters()

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

int64 translated_characters = 7;

Returns:

The translatedCharacters.

getFailedCharacters

long getFailedCharacters()

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

int64 failed_characters = 8;

Returns:

The failedCharacters.

getTotalBillableCharacters

long getTotalBillableCharacters()

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

int64 total_billable_characters = 9;

Returns:

The totalBillableCharacters.

hasSubmitTime

boolean hasSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Returns:

Whether the submitTime field is set.

getSubmitTime

Timestamp getSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Returns:

The submitTime.

getSubmitTimeOrBuilder

TimestampOrBuilder getSubmitTimeOrBuilder()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;