com.google.cloud.translate.v3

Class BatchTranslateDocumentMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.translate.v3.BatchTranslateDocumentMetadata

All Implemented Interfaces:

BatchTranslateDocumentMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BatchTranslateDocumentMetadata
extends com.google.protobuf.GeneratedMessageV3
implements BatchTranslateDocumentMetadataOrBuilder

 State metadata for the batch translation operation.
 

Protobuf type google.cloud.translation.v3.BatchTranslateDocumentMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchTranslateDocumentMetadata.Builder State metadata for the batch translation operation.
static class	BatchTranslateDocumentMetadata.State State of the job.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAILED_CHARACTERS_FIELD_NUMBER
static int	FAILED_PAGES_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	SUBMIT_TIME_FIELD_NUMBER
static int	TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER
static int	TOTAL_BILLABLE_PAGES_FIELD_NUMBER
static int	TOTAL_CHARACTERS_FIELD_NUMBER
static int	TOTAL_PAGES_FIELD_NUMBER
static int	TRANSLATED_CHARACTERS_FIELD_NUMBER
static int	TRANSLATED_PAGES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static BatchTranslateDocumentMetadata	getDefaultInstance()
BatchTranslateDocumentMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<BatchTranslateDocumentMetadata>	getParserForType()
int	getSerializedSize()
BatchTranslateDocumentMetadata.State	getState() The state of the operation.
int	getStateValue() The state of the operation.
com.google.protobuf.Timestamp	getSubmitTime() Time when the operation was submitted.
com.google.protobuf.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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasSubmitTime() Time when the operation was submitted.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BatchTranslateDocumentMetadata.Builder	newBuilder()
static BatchTranslateDocumentMetadata.Builder	newBuilder(BatchTranslateDocumentMetadata prototype)
BatchTranslateDocumentMetadata.Builder	newBuilderForType()
protected BatchTranslateDocumentMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchTranslateDocumentMetadata	parseDelimitedFrom(InputStream input)
static BatchTranslateDocumentMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentMetadata	parseFrom(byte[] data)
static BatchTranslateDocumentMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentMetadata	parseFrom(ByteBuffer data)
static BatchTranslateDocumentMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentMetadata	parseFrom(com.google.protobuf.ByteString data)
static BatchTranslateDocumentMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static BatchTranslateDocumentMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentMetadata	parseFrom(InputStream input)
static BatchTranslateDocumentMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchTranslateDocumentMetadata>	parser()
BatchTranslateDocumentMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_PAGES_FIELD_NUMBER

public static final int TOTAL_PAGES_FIELD_NUMBER

See Also:

Constant Field Values

TRANSLATED_PAGES_FIELD_NUMBER

public static final int TRANSLATED_PAGES_FIELD_NUMBER

See Also:

Constant Field Values

FAILED_PAGES_FIELD_NUMBER

public static final int FAILED_PAGES_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_BILLABLE_PAGES_FIELD_NUMBER

public static final int TOTAL_BILLABLE_PAGES_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_CHARACTERS_FIELD_NUMBER

public static final int TOTAL_CHARACTERS_FIELD_NUMBER

See Also:

Constant Field Values

TRANSLATED_CHARACTERS_FIELD_NUMBER

public static final int TRANSLATED_CHARACTERS_FIELD_NUMBER

See Also:

Constant Field Values

FAILED_CHARACTERS_FIELD_NUMBER

public static final int FAILED_CHARACTERS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER

public static final int TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER

See Also:

Constant Field Values

SUBMIT_TIME_FIELD_NUMBER

public static final int SUBMIT_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getStateValue

public int getStateValue()

 The state of the operation.
 

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

Specified by:

getStateValue in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public BatchTranslateDocumentMetadata.State getState()

 The state of the operation.
 

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

Specified by:

getState in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The state.

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;

Specified by:

getTotalPages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalPages.

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;

Specified by:

getTranslatedPages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The translatedPages.

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;

Specified by:

getFailedPages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The failedPages.

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;

Specified by:

getTotalBillablePages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalBillablePages.

getTotalCharacters

public long getTotalCharacters()

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

int64 total_characters = 6;

Specified by:

getTotalCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalCharacters.

getTranslatedCharacters

public long getTranslatedCharacters()

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

int64 translated_characters = 7;

Specified by:

getTranslatedCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The translatedCharacters.

getFailedCharacters

public long getFailedCharacters()

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

int64 failed_characters = 8;

Specified by:

getFailedCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The failedCharacters.

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;

Specified by:

getTotalBillableCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalBillableCharacters.

hasSubmitTime

public boolean hasSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Specified by:

hasSubmitTime in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

Whether the submitTime field is set.

getSubmitTime

public com.google.protobuf.Timestamp getSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Specified by:

getSubmitTime in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The submitTime.

getSubmitTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getSubmitTimeOrBuilder()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Specified by:

getSubmitTimeOrBuilder in interface BatchTranslateDocumentMetadataOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchTranslateDocumentMetadata parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchTranslateDocumentMetadata parseDelimitedFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static BatchTranslateDocumentMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public BatchTranslateDocumentMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BatchTranslateDocumentMetadata.Builder newBuilder()

newBuilder

public static BatchTranslateDocumentMetadata.Builder newBuilder(BatchTranslateDocumentMetadata prototype)

toBuilder

public BatchTranslateDocumentMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BatchTranslateDocumentMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BatchTranslateDocumentMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<BatchTranslateDocumentMetadata> parser()

getParserForType

public com.google.protobuf.Parser<BatchTranslateDocumentMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BatchTranslateDocumentMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder