Class BatchTranslateDocumentMetadata (2.28.0)

public final class BatchTranslateDocumentMetadata extends GeneratedMessageV3 implements BatchTranslateDocumentMetadataOrBuilder

State metadata for the batch translation operation.

Protobuf type google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

Inheritance

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

Static Fields

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

STATE_FIELD_NUMBER

public static final int STATE_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 BatchTranslateDocumentMetadata getDefaultInstance()
Returns
TypeDescription
BatchTranslateDocumentMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BatchTranslateDocumentMetadata prototype)

public static BatchTranslateDocumentMetadata.Builder newBuilder(BatchTranslateDocumentMetadata prototype)
Parameter
NameDescription
prototypeBatchTranslateDocumentMetadata
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchTranslateDocumentMetadata getDefaultInstanceForType()
Returns
TypeDescription
BatchTranslateDocumentMetadata

getFailedCharacters()

public long getFailedCharacters()

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

int64 failed_characters = 8;

Returns
TypeDescription
long

The failedCharacters.

getFailedPages()

public 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
TypeDescription
long

The failedPages.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public BatchTranslateDocumentMetadata.State getState()

The state of the operation.

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

Returns
TypeDescription
BatchTranslateDocumentMetadata.State

The state.

getStateValue()

public int getStateValue()

The state of the operation.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getSubmitTime()

public Timestamp getSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
Timestamp

The submitTime.

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
TimestampOrBuilder

getTotalBillableCharacters()

public 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
TypeDescription
long

The totalBillableCharacters.

getTotalBillablePages()

public 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
TypeDescription
long

The totalBillablePages.

getTotalCharacters()

public long getTotalCharacters()

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

int64 total_characters = 6;

Returns
TypeDescription
long

The totalCharacters.

getTotalPages()

public 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
TypeDescription
long

The totalPages.

getTranslatedCharacters()

public long getTranslatedCharacters()

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

int64 translated_characters = 7;

Returns
TypeDescription
long

The translatedCharacters.

getTranslatedPages()

public 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
TypeDescription
long

The translatedPages.

hasSubmitTime()

public boolean hasSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

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 BatchTranslateDocumentMetadata.Builder newBuilderForType()
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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