Class BatchTranslateDocumentMetadata (2.21.0)

public final class BatchTranslateDocumentMetadata extends GeneratedMessageV3 implements BatchTranslateDocumentMetadataOrBuilder

State metadata for the batch translation operation.

Protobuf type google.cloud.translation.v3.BatchTranslateDocumentMetadata

Inheritance

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

Implements

BatchTranslateDocumentMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FAILED_CHARACTERS_FIELD_NUMBER

public static final int FAILED_CHARACTERS_FIELD_NUMBER

Field Value
Type	Description
`int`

FAILED_PAGES_FIELD_NUMBER

public static final int FAILED_PAGES_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

SUBMIT_TIME_FIELD_NUMBER

public static final int SUBMIT_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER

public static final int TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER

Field Value
Type	Description
`int`

TOTAL_BILLABLE_PAGES_FIELD_NUMBER

public static final int TOTAL_BILLABLE_PAGES_FIELD_NUMBER

Field Value
Type	Description
`int`

TOTAL_CHARACTERS_FIELD_NUMBER

public static final int TOTAL_CHARACTERS_FIELD_NUMBER

Field Value
Type	Description
`int`

TOTAL_PAGES_FIELD_NUMBER

public static final int TOTAL_PAGES_FIELD_NUMBER

Field Value
Type	Description
`int`

TRANSLATED_CHARACTERS_FIELD_NUMBER

public static final int TRANSLATED_CHARACTERS_FIELD_NUMBER

Field Value
Type	Description
`int`

TRANSLATED_PAGES_FIELD_NUMBER

public static final int TRANSLATED_PAGES_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static BatchTranslateDocumentMetadata getDefaultInstance()

Returns
Type	Description
`BatchTranslateDocumentMetadata`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static BatchTranslateDocumentMetadata.Builder newBuilder()

Returns
Type	Description
`BatchTranslateDocumentMetadata.Builder`

newBuilder(BatchTranslateDocumentMetadata prototype)

public static BatchTranslateDocumentMetadata.Builder newBuilder(BatchTranslateDocumentMetadata prototype)

Parameter
Name	Description
`prototype`	`BatchTranslateDocumentMetadata`

Returns
Type	Description
`BatchTranslateDocumentMetadata.Builder`

parseDelimitedFrom(InputStream input)

public static BatchTranslateDocumentMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static BatchTranslateDocumentMetadata parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static BatchTranslateDocumentMetadata parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static BatchTranslateDocumentMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static BatchTranslateDocumentMetadata parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static BatchTranslateDocumentMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchTranslateDocumentMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchTranslateDocumentMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<BatchTranslateDocumentMetadata> parser()

Returns
Type	Description
`Parser<BatchTranslateDocumentMetadata>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public BatchTranslateDocumentMetadata getDefaultInstanceForType()

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`long`	The failedPages.

getParserForType()

public Parser<BatchTranslateDocumentMetadata> getParserForType()

Returns
Type	Description
`Parser<BatchTranslateDocumentMetadata>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public BatchTranslateDocumentMetadata.State getState()

The state of the operation.

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

Returns
Type	Description
`BatchTranslateDocumentMetadata.State`	The state.

getStateValue()

public int getStateValue()

The state of the operation.

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

Returns
Type	Description
`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
Type	Description
`Timestamp`	The submitTime.

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`long`	The totalBillablePages.

getTotalCharacters()

public long getTotalCharacters()

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

int64 total_characters = 6;

Returns
Type	Description
`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
Type	Description
`long`	The totalPages.

getTranslatedCharacters()

public long getTranslatedCharacters()

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

int64 translated_characters = 7;

Returns
Type	Description
`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
Type	Description
`long`	The translatedPages.

hasSubmitTime()

public boolean hasSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
Type	Description
`boolean`	Whether the submitTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BatchTranslateDocumentMetadata.Builder newBuilderForType()

Returns
Type	Description
`BatchTranslateDocumentMetadata.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchTranslateDocumentMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`BatchTranslateDocumentMetadata.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BatchTranslateDocumentMetadata.Builder toBuilder()

Returns
Type	Description
`BatchTranslateDocumentMetadata.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`