Class BatchTranslateDocumentMetadata.Builder (2.53.0)

Version latest

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.5
• 2.2.0
• 2.1.13

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.v3.BatchTranslateDocumentMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchTranslateDocumentMetadata.Builder

Implements

BatchTranslateDocumentMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateDocumentMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public BatchTranslateDocumentMetadata build()

Returns
Type	Description
BatchTranslateDocumentMetadata

buildPartial()

public BatchTranslateDocumentMetadata buildPartial()

Returns
Type	Description
BatchTranslateDocumentMetadata

clear()

public BatchTranslateDocumentMetadata.Builder clear()

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
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
Type	Description
BatchTranslateDocumentMetadata.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchTranslateDocumentMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchTranslateDocumentMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearState()

public BatchTranslateDocumentMetadata.Builder clearState()

The state of the operation.

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

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder	This builder for chaining.

clearSubmitTime()

public BatchTranslateDocumentMetadata.Builder clearSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
BatchTranslateDocumentMetadata.Builder	This builder for chaining.

clone()

public BatchTranslateDocumentMetadata.Builder clone()

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public BatchTranslateDocumentMetadata getDefaultInstanceForType()

Returns
Type	Description
BatchTranslateDocumentMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFailedCharacters()

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.

getState()

public BatchTranslateDocumentMetadata.State getState()

The state of the operation.

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

Returns
Type	Description
BatchTranslateDocumentMetadata.State	The state.

getStateValue()

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.

getSubmitTime()

public Timestamp getSubmitTime()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
Type	Description
Timestamp	The submitTime.

getSubmitTimeBuilder()

public Timestamp.Builder getSubmitTimeBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
Type	Description
Builder

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Returns
Type	Description
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
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.

getTotalCharacters()

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.

getTranslatedCharacters()

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.

hasSubmitTime()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BatchTranslateDocumentMetadata other)

public BatchTranslateDocumentMetadata.Builder mergeFrom(BatchTranslateDocumentMetadata other)

Parameter
Name	Description
other	BatchTranslateDocumentMetadata

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchTranslateDocumentMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BatchTranslateDocumentMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSubmitTime(Timestamp value)

public BatchTranslateDocumentMetadata.Builder mergeSubmitTime(Timestamp value)

Time when the operation was submitted.

.google.protobuf.Timestamp submit_time = 10;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateDocumentMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
value	long The failedCharacters to set.

Returns
Type	Description
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
Name	Description
value	long The failedPages to set.

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchTranslateDocumentMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setState(BatchTranslateDocumentMetadata.State value)

public BatchTranslateDocumentMetadata.Builder setState(BatchTranslateDocumentMetadata.State value)

The state of the operation.

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

Parameter
Name	Description
value	BatchTranslateDocumentMetadata.State The state to set.

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder	This builder for chaining.

setStateValue(int value)

public BatchTranslateDocumentMetadata.Builder setStateValue(int value)

The state of the operation.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for state to set.

Returns
Type	Description
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
Name	Description
value	Timestamp

Returns
Type	Description
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
Name	Description
builderForValue	Builder

Returns
Type	Description
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
Name	Description
value	long The totalBillableCharacters to set.

Returns
Type	Description
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
Name	Description
value	long The totalBillablePages to set.

Returns
Type	Description
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
Name	Description
value	long The totalCharacters to set.

Returns
Type	Description
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
Name	Description
value	long The totalPages to set.

Returns
Type	Description
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
Name	Description
value	long The translatedCharacters to set.

Returns
Type	Description
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
Name	Description
value	long The translatedPages to set.

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchTranslateDocumentMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchTranslateDocumentMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)