Class BatchTranslateDocumentResponse.Builder (2.49.0)

public static final class BatchTranslateDocumentResponse.Builder extends GeneratedMessageV3.Builder<BatchTranslateDocumentResponse.Builder> implements BatchTranslateDocumentResponseOrBuilder

Stored in the google.longrunning.Operation.response field returned by BatchTranslateDocument if at least one document is translated successfully.

Protobuf type google.cloud.translation.v3.BatchTranslateDocumentResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateDocumentResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

build()

public BatchTranslateDocumentResponse build()
Returns
Type Description
BatchTranslateDocumentResponse

buildPartial()

public BatchTranslateDocumentResponse buildPartial()
Returns
Type Description
BatchTranslateDocumentResponse

clear()

public BatchTranslateDocumentResponse.Builder clear()
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

clearEndTime()

public BatchTranslateDocumentResponse.Builder clearEndTime()

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

clearFailedCharacters()

public BatchTranslateDocumentResponse.Builder clearFailedCharacters()

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

int64 failed_characters = 7;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearFailedPages()

public BatchTranslateDocumentResponse.Builder clearFailedPages()

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;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchTranslateDocumentResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchTranslateDocumentResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

clearSubmitTime()

public BatchTranslateDocumentResponse.Builder clearSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

clearTotalBillableCharacters()

public BatchTranslateDocumentResponse.Builder clearTotalBillableCharacters()

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

int64 total_billable_characters = 8;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearTotalBillablePages()

public BatchTranslateDocumentResponse.Builder clearTotalBillablePages()

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

int64 total_billable_pages = 4;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearTotalCharacters()

public BatchTranslateDocumentResponse.Builder clearTotalCharacters()

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

int64 total_characters = 5;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearTotalPages()

public BatchTranslateDocumentResponse.Builder clearTotalPages()

Total number of pages to translate in all documents. Documents without clear page definition (such as XLSX) are not counted.

int64 total_pages = 1;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearTranslatedCharacters()

public BatchTranslateDocumentResponse.Builder clearTranslatedCharacters()

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

int64 translated_characters = 6;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clearTranslatedPages()

public BatchTranslateDocumentResponse.Builder clearTranslatedPages()

Number of successfully translated pages in all documents. Documents without clear page definition (such as XLSX) are not counted.

int64 translated_pages = 2;

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

clone()

public BatchTranslateDocumentResponse.Builder clone()
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

getDefaultInstanceForType()

public BatchTranslateDocumentResponse getDefaultInstanceForType()
Returns
Type Description
BatchTranslateDocumentResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Returns
Type Description
TimestampOrBuilder

getFailedCharacters()

public long getFailedCharacters()

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

int64 failed_characters = 7;

Returns
Type Description
long

The failedCharacters.

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;

Returns
Type Description
long

The failedPages.

getSubmitTime()

public Timestamp getSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
Type Description
Timestamp

The submitTime.

getSubmitTimeBuilder()

public Timestamp.Builder getSubmitTimeBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
Type Description
Builder

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
Type Description
TimestampOrBuilder

getTotalBillableCharacters()

public long getTotalBillableCharacters()

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

int64 total_billable_characters = 8;

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)

int64 total_billable_pages = 4;

Returns
Type Description
long

The totalBillablePages.

getTotalCharacters()

public long getTotalCharacters()

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

int64 total_characters = 5;

Returns
Type Description
long

The totalCharacters.

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;

Returns
Type Description
long

The totalPages.

getTranslatedCharacters()

public long getTranslatedCharacters()

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

int64 translated_characters = 6;

Returns
Type Description
long

The translatedCharacters.

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;

Returns
Type Description
long

The translatedPages.

hasEndTime()

public boolean hasEndTime()

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Returns
Type Description
boolean

Whether the endTime field is set.

hasSubmitTime()

public boolean hasSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Returns
Type Description
boolean

Whether the submitTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public BatchTranslateDocumentResponse.Builder mergeEndTime(Timestamp value)

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchTranslateDocumentResponse.Builder

mergeFrom(BatchTranslateDocumentResponse other)

public BatchTranslateDocumentResponse.Builder mergeFrom(BatchTranslateDocumentResponse other)
Parameter
Name Description
other BatchTranslateDocumentResponse
Returns
Type Description
BatchTranslateDocumentResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchTranslateDocumentResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchTranslateDocumentResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

mergeSubmitTime(Timestamp value)

public BatchTranslateDocumentResponse.Builder mergeSubmitTime(Timestamp value)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchTranslateDocumentResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateDocumentResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

setEndTime(Timestamp value)

public BatchTranslateDocumentResponse.Builder setEndTime(Timestamp value)

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchTranslateDocumentResponse.Builder

setEndTime(Timestamp.Builder builderForValue)

public BatchTranslateDocumentResponse.Builder setEndTime(Timestamp.Builder builderForValue)

The time when the operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 10;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchTranslateDocumentResponse.Builder

setFailedCharacters(long value)

public BatchTranslateDocumentResponse.Builder setFailedCharacters(long value)

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

int64 failed_characters = 7;

Parameter
Name Description
value long

The failedCharacters to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setFailedPages(long value)

public BatchTranslateDocumentResponse.Builder setFailedPages(long value)

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;

Parameter
Name Description
value long

The failedPages to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateDocumentResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

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

public BatchTranslateDocumentResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides

setSubmitTime(Timestamp value)

public BatchTranslateDocumentResponse.Builder setSubmitTime(Timestamp value)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchTranslateDocumentResponse.Builder

setSubmitTime(Timestamp.Builder builderForValue)

public BatchTranslateDocumentResponse.Builder setSubmitTime(Timestamp.Builder builderForValue)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 9;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchTranslateDocumentResponse.Builder

setTotalBillableCharacters(long value)

public BatchTranslateDocumentResponse.Builder setTotalBillableCharacters(long value)

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

int64 total_billable_characters = 8;

Parameter
Name Description
value long

The totalBillableCharacters to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setTotalBillablePages(long value)

public BatchTranslateDocumentResponse.Builder setTotalBillablePages(long value)

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

int64 total_billable_pages = 4;

Parameter
Name Description
value long

The totalBillablePages to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setTotalCharacters(long value)

public BatchTranslateDocumentResponse.Builder setTotalCharacters(long value)

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

int64 total_characters = 5;

Parameter
Name Description
value long

The totalCharacters to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setTotalPages(long value)

public BatchTranslateDocumentResponse.Builder setTotalPages(long value)

Total number of pages to translate in all documents. Documents without clear page definition (such as XLSX) are not counted.

int64 total_pages = 1;

Parameter
Name Description
value long

The totalPages to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setTranslatedCharacters(long value)

public BatchTranslateDocumentResponse.Builder setTranslatedCharacters(long value)

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

int64 translated_characters = 6;

Parameter
Name Description
value long

The translatedCharacters to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setTranslatedPages(long value)

public BatchTranslateDocumentResponse.Builder setTranslatedPages(long value)

Number of successfully translated pages in all documents. Documents without clear page definition (such as XLSX) are not counted.

int64 translated_pages = 2;

Parameter
Name Description
value long

The translatedPages to set.

Returns
Type Description
BatchTranslateDocumentResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateDocumentResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchTranslateDocumentResponse.Builder
Overrides