Class BatchTranslateDocumentResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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

@Generated public final class BatchTranslateDocumentResponse extends com.google.protobuf.GeneratedMessage 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 type google.cloud.translation.v3.BatchTranslateDocumentResponse
See Also:
  • Field Details

    • TOTAL_PAGES_FIELD_NUMBER

      public static final int TOTAL_PAGES_FIELD_NUMBER
      See Also:
    • TRANSLATED_PAGES_FIELD_NUMBER

      public static final int TRANSLATED_PAGES_FIELD_NUMBER
      See Also:
    • FAILED_PAGES_FIELD_NUMBER

      public static final int FAILED_PAGES_FIELD_NUMBER
      See Also:
    • TOTAL_BILLABLE_PAGES_FIELD_NUMBER

      public static final int TOTAL_BILLABLE_PAGES_FIELD_NUMBER
      See Also:
    • TOTAL_CHARACTERS_FIELD_NUMBER

      public static final int TOTAL_CHARACTERS_FIELD_NUMBER
      See Also:
    • TRANSLATED_CHARACTERS_FIELD_NUMBER

      public static final int TRANSLATED_CHARACTERS_FIELD_NUMBER
      See Also:
    • FAILED_CHARACTERS_FIELD_NUMBER

      public static final int FAILED_CHARACTERS_FIELD_NUMBER
      See Also:
    • TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER

      public static final int TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER
      See Also:
    • SUBMIT_TIME_FIELD_NUMBER

      public static final int SUBMIT_TIME_FIELD_NUMBER
      See Also:
    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      Returns:
      The totalBillablePages.
    • getTotalCharacters

      public long getTotalCharacters()
       Total number of characters (Unicode codepoints) in all documents.
       
      int64 total_characters = 5;
      Specified by:
      getTotalCharacters in interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      Returns:
      The totalBillableCharacters.
    • hasSubmitTime

      public boolean hasSubmitTime()
       Time when the operation was submitted.
       
      .google.protobuf.Timestamp submit_time = 9;
      Specified by:
      hasSubmitTime in interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
    • 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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
      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 interface BatchTranslateDocumentResponseOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 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 interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static BatchTranslateDocumentResponse.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected BatchTranslateDocumentResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public BatchTranslateDocumentResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder