public final class BatchTranslateDocumentMetadata extends GeneratedMessageV3 implements BatchTranslateDocumentMetadataOrBuilder
State metadata for the batch translation operation.
Protobuf type google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
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 | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SUBMIT_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
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 | |
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 | |
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
public static BatchTranslateDocumentMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static BatchTranslateDocumentMetadata.Builder newBuilder()
public static BatchTranslateDocumentMetadata.Builder newBuilder(BatchTranslateDocumentMetadata prototype)
public static BatchTranslateDocumentMetadata parseDelimitedFrom(InputStream input)
public static BatchTranslateDocumentMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static BatchTranslateDocumentMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentMetadata parseFrom(ByteString data)
public static BatchTranslateDocumentMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentMetadata parseFrom(CodedInputStream input)
public static BatchTranslateDocumentMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentMetadata parseFrom(InputStream input)
public static BatchTranslateDocumentMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchTranslateDocumentMetadata parseFrom(ByteBuffer data)
public static BatchTranslateDocumentMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<BatchTranslateDocumentMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public BatchTranslateDocumentMetadata getDefaultInstanceForType()
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()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public BatchTranslateDocumentMetadata.State getState()
The state of the operation.
.google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata.State state = 1;
public int getStateValue()
The state of the operation.
.google.cloud.translation.v3beta1.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 |
|---|
| Type | Description |
Timestamp | The submitTime.
|
public TimestampOrBuilder getSubmitTimeOrBuilder()
Time when the operation was submitted.
.google.protobuf.Timestamp submit_time = 10;
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 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 |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public BatchTranslateDocumentMetadata.Builder newBuilderForType()
protected BatchTranslateDocumentMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public BatchTranslateDocumentMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
