Class BatchTranslateDocumentResponse (2.3.3)

Stay organized with collections Save and categorize content based on your preferences.
public final class BatchTranslateDocumentResponse extends GeneratedMessageV3 implements BatchTranslateDocumentResponseOrBuilder

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

Protobuf type google.cloud.translation.v3beta1.BatchTranslateDocumentResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchTranslateDocumentResponse

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

FAILED_CHARACTERS_FIELD_NUMBER

public static final int FAILED_CHARACTERS_FIELD_NUMBER
Field Value
TypeDescription
int

FAILED_PAGES_FIELD_NUMBER

public static final int FAILED_PAGES_FIELD_NUMBER
Field Value
TypeDescription
int

SUBMIT_TIME_FIELD_NUMBER

public static final int SUBMIT_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER

public static final int TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_BILLABLE_PAGES_FIELD_NUMBER

public static final int TOTAL_BILLABLE_PAGES_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_CHARACTERS_FIELD_NUMBER

public static final int TOTAL_CHARACTERS_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_PAGES_FIELD_NUMBER

public static final int TOTAL_PAGES_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSLATED_CHARACTERS_FIELD_NUMBER

public static final int TRANSLATED_CHARACTERS_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSLATED_PAGES_FIELD_NUMBER

public static final int TRANSLATED_PAGES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchTranslateDocumentResponse getDefaultInstance()
Returns
TypeDescription
BatchTranslateDocumentResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BatchTranslateDocumentResponse.Builder newBuilder()
Returns
TypeDescription
BatchTranslateDocumentResponse.Builder

newBuilder(BatchTranslateDocumentResponse prototype)

public static BatchTranslateDocumentResponse.Builder newBuilder(BatchTranslateDocumentResponse prototype)
Parameter
NameDescription
prototypeBatchTranslateDocumentResponse
Returns
TypeDescription
BatchTranslateDocumentResponse.Builder

parseDelimitedFrom(InputStream input)

public static BatchTranslateDocumentResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BatchTranslateDocumentResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchTranslateDocumentResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchTranslateDocumentResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BatchTranslateDocumentResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BatchTranslateDocumentResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BatchTranslateDocumentResponse> parser()
Returns
TypeDescription
Parser<BatchTranslateDocumentResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BatchTranslateDocumentResponse getDefaultInstanceForType()
Returns
TypeDescription
BatchTranslateDocumentResponse

getEndTime()

public Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 10;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 10;

Returns
TypeDescription
TimestampOrBuilder

getFailedCharacters()

public long getFailedCharacters()

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

int64 failed_characters = 7;

Returns
TypeDescription
long

The failedCharacters.

getFailedPages()

public long getFailedPages()

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

int64 failed_pages = 3;

Returns
TypeDescription
long

The failedPages.

getParserForType()

public Parser<BatchTranslateDocumentResponse> getParserForType()
Returns
TypeDescription
Parser<BatchTranslateDocumentResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubmitTime()

public Timestamp getSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
TypeDescription
Timestamp

The submitTime.

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
TypeDescription
TimestampOrBuilder

getTotalBillableCharacters()

public long getTotalBillableCharacters()

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

int64 total_billable_characters = 8;

Returns
TypeDescription
long

The totalBillableCharacters.

getTotalBillablePages()

public long getTotalBillablePages()

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

int64 total_billable_pages = 4;

Returns
TypeDescription
long

The totalBillablePages.

getTotalCharacters()

public long getTotalCharacters()

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

int64 total_characters = 5;

Returns
TypeDescription
long

The totalCharacters.

getTotalPages()

public long getTotalPages()

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

int64 total_pages = 1;

Returns
TypeDescription
long

The totalPages.

getTranslatedCharacters()

public long getTranslatedCharacters()

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

int64 translated_characters = 6;

Returns
TypeDescription
long

The translatedCharacters.

getTranslatedPages()

public long getTranslatedPages()

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

int64 translated_pages = 2;

Returns
TypeDescription
long

The translatedPages.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasEndTime()

public boolean hasEndTime()

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

.google.protobuf.Timestamp end_time = 10;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasSubmitTime()

public boolean hasSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
TypeDescription
boolean

Whether the submitTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BatchTranslateDocumentResponse.Builder newBuilderForType()
Returns
TypeDescription
BatchTranslateDocumentResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchTranslateDocumentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BatchTranslateDocumentResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BatchTranslateDocumentResponse.Builder toBuilder()
Returns
TypeDescription
BatchTranslateDocumentResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException