Class BatchTranslateDocumentMetadata.Builder

public static final class BatchTranslateDocumentMetadata.Builder extends GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder> implements BatchTranslateDocumentMetadataOrBuilder

State metadata for the batch translation operation.

Protobuf type google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateDocumentMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

build()

public BatchTranslateDocumentMetadata build()
Returns
TypeDescription
BatchTranslateDocumentMetadata

buildPartial()

public BatchTranslateDocumentMetadata buildPartial()
Returns
TypeDescription
BatchTranslateDocumentMetadata

clear()

public BatchTranslateDocumentMetadata.Builder clear()
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

clearFailedCharacters()

public BatchTranslateDocumentMetadata.Builder clearFailedCharacters()

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

int64 failed_characters = 8;

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearFailedPages()

public BatchTranslateDocumentMetadata.Builder clearFailedPages()

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
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchTranslateDocumentMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchTranslateDocumentMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

clearState()

public BatchTranslateDocumentMetadata.Builder clearState()

The state of the operation.

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

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearSubmitTime()

public BatchTranslateDocumentMetadata.Builder clearSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

clearTotalBillableCharacters()

public BatchTranslateDocumentMetadata.Builder clearTotalBillableCharacters()

Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.

int64 total_billable_characters = 9;

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearTotalBillablePages()

public BatchTranslateDocumentMetadata.Builder clearTotalBillablePages()

Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.

int64 total_billable_pages = 5;

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearTotalCharacters()

public BatchTranslateDocumentMetadata.Builder clearTotalCharacters()

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

int64 total_characters = 6;

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearTotalPages()

public BatchTranslateDocumentMetadata.Builder clearTotalPages()

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
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearTranslatedCharacters()

public BatchTranslateDocumentMetadata.Builder clearTranslatedCharacters()

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

int64 translated_characters = 7;

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clearTranslatedPages()

public BatchTranslateDocumentMetadata.Builder clearTranslatedPages()

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
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

clone()

public BatchTranslateDocumentMetadata.Builder clone()
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

getDefaultInstanceForType()

public BatchTranslateDocumentMetadata getDefaultInstanceForType()
Returns
TypeDescription
BatchTranslateDocumentMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFailedCharacters()

public long getFailedCharacters()

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

int64 failed_characters = 8;

Returns
TypeDescription
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
TypeDescription
long

The failedPages.

getState()

public BatchTranslateDocumentMetadata.State getState()

The state of the operation.

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

Returns
TypeDescription
BatchTranslateDocumentMetadata.State

The state.

getStateValue()

public int getStateValue()

The state of the operation.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getSubmitTime()

public Timestamp getSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
Timestamp

The submitTime.

getSubmitTimeBuilder()

public Timestamp.Builder getSubmitTimeBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
Builder

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
TimestampOrBuilder

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;

Returns
TypeDescription
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
TypeDescription
long

The totalBillablePages.

getTotalCharacters()

public long getTotalCharacters()

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

int64 total_characters = 6;

Returns
TypeDescription
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
TypeDescription
long

The totalPages.

getTranslatedCharacters()

public long getTranslatedCharacters()

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

int64 translated_characters = 7;

Returns
TypeDescription
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
TypeDescription
long

The translatedPages.

hasSubmitTime()

public boolean hasSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
TypeDescription
boolean

Whether the submitTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BatchTranslateDocumentMetadata other)

public BatchTranslateDocumentMetadata.Builder mergeFrom(BatchTranslateDocumentMetadata other)
Parameter
NameDescription
otherBatchTranslateDocumentMetadata
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchTranslateDocumentMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BatchTranslateDocumentMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

mergeSubmitTime(Timestamp value)

public BatchTranslateDocumentMetadata.Builder mergeSubmitTime(Timestamp value)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateDocumentMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

setFailedCharacters(long value)

public BatchTranslateDocumentMetadata.Builder setFailedCharacters(long value)

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

int64 failed_characters = 8;

Parameter
NameDescription
valuelong

The failedCharacters to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setFailedPages(long value)

public BatchTranslateDocumentMetadata.Builder setFailedPages(long value)

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;

Parameter
NameDescription
valuelong

The failedPages to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateDocumentMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchTranslateDocumentMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides

setState(BatchTranslateDocumentMetadata.State value)

public BatchTranslateDocumentMetadata.Builder setState(BatchTranslateDocumentMetadata.State value)

The state of the operation.

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

Parameter
NameDescription
valueBatchTranslateDocumentMetadata.State

The state to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setStateValue(int value)

public BatchTranslateDocumentMetadata.Builder setStateValue(int value)

The state of the operation.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setSubmitTime(Timestamp value)

public BatchTranslateDocumentMetadata.Builder setSubmitTime(Timestamp value)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

setSubmitTime(Timestamp.Builder builderForValue)

public BatchTranslateDocumentMetadata.Builder setSubmitTime(Timestamp.Builder builderForValue)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

setTotalBillableCharacters(long value)

public BatchTranslateDocumentMetadata.Builder setTotalBillableCharacters(long value)

Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.

int64 total_billable_characters = 9;

Parameter
NameDescription
valuelong

The totalBillableCharacters to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setTotalBillablePages(long value)

public BatchTranslateDocumentMetadata.Builder setTotalBillablePages(long value)

Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.

int64 total_billable_pages = 5;

Parameter
NameDescription
valuelong

The totalBillablePages to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setTotalCharacters(long value)

public BatchTranslateDocumentMetadata.Builder setTotalCharacters(long value)

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

int64 total_characters = 6;

Parameter
NameDescription
valuelong

The totalCharacters to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setTotalPages(long value)

public BatchTranslateDocumentMetadata.Builder setTotalPages(long value)

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;

Parameter
NameDescription
valuelong

The totalPages to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setTranslatedCharacters(long value)

public BatchTranslateDocumentMetadata.Builder setTranslatedCharacters(long value)

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

int64 translated_characters = 7;

Parameter
NameDescription
valuelong

The translatedCharacters to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setTranslatedPages(long value)

public BatchTranslateDocumentMetadata.Builder setTranslatedPages(long value)

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;

Parameter
NameDescription
valuelong

The translatedPages to set.

Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateDocumentMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchTranslateDocumentMetadata.Builder
Overrides