Package com.google.cloud.translate.v3
Class BatchTranslateDocumentResponse
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.translate.v3.BatchTranslateDocumentResponse
-
- All Implemented Interfaces:
BatchTranslateDocumentResponseOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class BatchTranslateDocumentResponse extends com.google.protobuf.GeneratedMessageV3 implements BatchTranslateDocumentResponseOrBuilder
Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateDocument if at least one document is translated successfully.
Protobuf typegoogle.cloud.translation.v3.BatchTranslateDocumentResponse
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BatchTranslateDocumentResponse.Builder
Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateDocument if at least one document is translated successfully.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
END_TIME_FIELD_NUMBER
static int
FAILED_CHARACTERS_FIELD_NUMBER
static int
FAILED_PAGES_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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
static BatchTranslateDocumentResponse
getDefaultInstance()
BatchTranslateDocumentResponse
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Timestamp
getEndTime()
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.com.google.protobuf.TimestampOrBuilder
getEndTimeOrBuilder()
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.long
getFailedCharacters()
Number of characters that have failed to process (Unicode codepoints) in all documents.long
getFailedPages()
Number of pages that failed to process in all documents.com.google.protobuf.Parser<BatchTranslateDocumentResponse>
getParserForType()
int
getSerializedSize()
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.long
getTotalBillablePages()
Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX)long
getTotalCharacters()
Total number of characters (Unicode codepoints) in all documents.long
getTotalPages()
Total number of pages to translate in all documents.long
getTranslatedCharacters()
Number of successfully translated characters (Unicode codepoints) in all documents.long
getTranslatedPages()
Number of successfully translated pages in all documents.boolean
hasEndTime()
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.int
hashCode()
boolean
hasSubmitTime()
Time when the operation was submitted.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static BatchTranslateDocumentResponse.Builder
newBuilder()
static BatchTranslateDocumentResponse.Builder
newBuilder(BatchTranslateDocumentResponse prototype)
BatchTranslateDocumentResponse.Builder
newBuilderForType()
protected BatchTranslateDocumentResponse.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchTranslateDocumentResponse
parseDelimitedFrom(InputStream input)
static BatchTranslateDocumentResponse
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentResponse
parseFrom(byte[] data)
static BatchTranslateDocumentResponse
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentResponse
parseFrom(com.google.protobuf.ByteString data)
static BatchTranslateDocumentResponse
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentResponse
parseFrom(com.google.protobuf.CodedInputStream input)
static BatchTranslateDocumentResponse
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentResponse
parseFrom(InputStream input)
static BatchTranslateDocumentResponse
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchTranslateDocumentResponse
parseFrom(ByteBuffer data)
static BatchTranslateDocumentResponse
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchTranslateDocumentResponse>
parser()
BatchTranslateDocumentResponse.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, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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
-
-
-
-
Field Detail
-
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
-
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
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;
- Specified by:
getTotalPages
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The totalPages.
-
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;
- Specified by:
getTranslatedPages
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The translatedPages.
-
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;
- Specified by:
getFailedPages
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The failedPages.
-
getTotalBillablePages
public long getTotalBillablePages()
Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX)
int64 total_billable_pages = 4;
- Specified by:
getTotalBillablePages
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The totalBillablePages.
-
getTotalCharacters
public long getTotalCharacters()
Total number of characters (Unicode codepoints) in all documents.
int64 total_characters = 5;
- Specified by:
getTotalCharacters
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The totalCharacters.
-
getTranslatedCharacters
public long getTranslatedCharacters()
Number of successfully translated characters (Unicode codepoints) in all documents.
int64 translated_characters = 6;
- Specified by:
getTranslatedCharacters
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The translatedCharacters.
-
getFailedCharacters
public long getFailedCharacters()
Number of characters that have failed to process (Unicode codepoints) in all documents.
int64 failed_characters = 7;
- Specified by:
getFailedCharacters
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The failedCharacters.
-
getTotalBillableCharacters
public long getTotalBillableCharacters()
Number of billable characters (Unicode codepoints) in documents without clear page definition, such as XLSX.
int64 total_billable_characters = 8;
- Specified by:
getTotalBillableCharacters
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The totalBillableCharacters.
-
hasSubmitTime
public boolean hasSubmitTime()
Time when the operation was submitted.
.google.protobuf.Timestamp submit_time = 9;
- Specified by:
hasSubmitTime
in interfaceBatchTranslateDocumentResponseOrBuilder
- 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 = 9;
- Specified by:
getSubmitTime
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The submitTime.
-
getSubmitTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getSubmitTimeOrBuilder()
Time when the operation was submitted.
.google.protobuf.Timestamp submit_time = 9;
- Specified by:
getSubmitTimeOrBuilder
in interfaceBatchTranslateDocumentResponseOrBuilder
-
hasEndTime
public boolean hasEndTime()
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
.google.protobuf.Timestamp end_time = 10;
- Specified by:
hasEndTime
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- Whether the endTime field is set.
-
getEndTime
public com.google.protobuf.Timestamp getEndTime()
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
.google.protobuf.Timestamp end_time = 10;
- Specified by:
getEndTime
in interfaceBatchTranslateDocumentResponseOrBuilder
- Returns:
- The endTime.
-
getEndTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
.google.protobuf.Timestamp end_time = 10;
- Specified by:
getEndTimeOrBuilder
in interfaceBatchTranslateDocumentResponseOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static BatchTranslateDocumentResponse parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static BatchTranslateDocumentResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static BatchTranslateDocumentResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public BatchTranslateDocumentResponse.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static BatchTranslateDocumentResponse.Builder newBuilder()
-
newBuilder
public static BatchTranslateDocumentResponse.Builder newBuilder(BatchTranslateDocumentResponse prototype)
-
toBuilder
public BatchTranslateDocumentResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected BatchTranslateDocumentResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static BatchTranslateDocumentResponse getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<BatchTranslateDocumentResponse> parser()
-
getParserForType
public com.google.protobuf.Parser<BatchTranslateDocumentResponse> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public BatchTranslateDocumentResponse getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-