Class BatchTranslateDocumentMetadata (2.7.0)
Version 2.7.0keyboard_arrow_down
public final class BatchTranslateDocumentMetadata extends GeneratedMessageV3 implements BatchTranslateDocumentMetadataOrBuilder
State metadata for the batch translation operation.
Protobuf type google.cloud.translation.v3.BatchTranslateDocumentMetadata
Static Fields
public static final int FAILED_CHARACTERS_FIELD_NUMBER
Field Value
FAILED_PAGES_FIELD_NUMBER
public static final int FAILED_PAGES_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
public static final int SUBMIT_TIME_FIELD_NUMBER
Field Value
public static final int TOTAL_BILLABLE_CHARACTERS_FIELD_NUMBER
Field Value
TOTAL_BILLABLE_PAGES_FIELD_NUMBER
public static final int TOTAL_BILLABLE_PAGES_FIELD_NUMBER
Field Value
public static final int TOTAL_CHARACTERS_FIELD_NUMBER
Field Value
TOTAL_PAGES_FIELD_NUMBER
public static final int TOTAL_PAGES_FIELD_NUMBER
Field Value
public static final int TRANSLATED_CHARACTERS_FIELD_NUMBER
Field Value
TRANSLATED_PAGES_FIELD_NUMBER
public static final int TRANSLATED_PAGES_FIELD_NUMBER
Field Value
Static Methods
public static BatchTranslateDocumentMetadata getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static BatchTranslateDocumentMetadata . Builder newBuilder ()
Returns
public static BatchTranslateDocumentMetadata . Builder newBuilder ( BatchTranslateDocumentMetadata prototype )
Parameter
Returns
public static BatchTranslateDocumentMetadata parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static BatchTranslateDocumentMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<BatchTranslateDocumentMetadata> parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public BatchTranslateDocumentMetadata getDefaultInstanceForType ()
Returns
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.
public Parser<BatchTranslateDocumentMetadata> getParserForType ()
Returns
Overrides
public int getSerializedSize ()
Returns
Overrides
public BatchTranslateDocumentMetadata . State getState ()
The state of the operation.
.google.cloud.translation.v3.BatchTranslateDocumentMetadata.State state = 1;
Returns
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.
public Timestamp getSubmitTime ()
Time when the operation was submitted.
.google.protobuf.Timestamp submit_time = 10;
Returns
public TimestampOrBuilder getSubmitTimeOrBuilder ()
Time when the operation was submitted.
.google.protobuf.Timestamp submit_time = 10;
Returns
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.
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.
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.
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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.
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public BatchTranslateDocumentMetadata . Builder newBuilderForType ()
Returns
protected BatchTranslateDocumentMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public BatchTranslateDocumentMetadata . Builder toBuilder ()
Returns
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
