com.google.cloud.translate.v3

Class BatchTranslateDocumentMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

com.google.cloud.translate.v3.BatchTranslateDocumentMetadata.Builder

All Implemented Interfaces:

BatchTranslateDocumentMetadataOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

BatchTranslateDocumentMetadata

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

Method Summary

Modifier and Type	Method and Description
BatchTranslateDocumentMetadata.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
BatchTranslateDocumentMetadata	build()
BatchTranslateDocumentMetadata	buildPartial()
BatchTranslateDocumentMetadata.Builder	clear()
BatchTranslateDocumentMetadata.Builder	clearFailedCharacters() Number of characters that have failed to process (Unicode codepoints) in all documents so far.
BatchTranslateDocumentMetadata.Builder	clearFailedPages() Number of pages that failed to process in all documents so far.
BatchTranslateDocumentMetadata.Builder	clearField(Descriptors.FieldDescriptor field)
BatchTranslateDocumentMetadata.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
BatchTranslateDocumentMetadata.Builder	clearState() The state of the operation.
BatchTranslateDocumentMetadata.Builder	clearSubmitTime() Time when the operation was submitted.
BatchTranslateDocumentMetadata.Builder	clearTotalBillableCharacters() Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
BatchTranslateDocumentMetadata.Builder	clearTotalBillablePages() Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
BatchTranslateDocumentMetadata.Builder	clearTotalCharacters() Total number of characters (Unicode codepoints) in all documents so far.
BatchTranslateDocumentMetadata.Builder	clearTotalPages() Total number of pages to translate in all documents so far.
BatchTranslateDocumentMetadata.Builder	clearTranslatedCharacters() Number of successfully translated characters (Unicode codepoints) in all documents so far.
BatchTranslateDocumentMetadata.Builder	clearTranslatedPages() Number of successfully translated pages in all documents so far.
BatchTranslateDocumentMetadata.Builder	clone()
BatchTranslateDocumentMetadata	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
long	getFailedCharacters() Number of characters that have failed to process (Unicode codepoints) in all documents so far.
long	getFailedPages() Number of pages that failed to process in all documents so far.
BatchTranslateDocumentMetadata.State	getState() The state of the operation.
int	getStateValue() The state of the operation.
Timestamp	getSubmitTime() Time when the operation was submitted.
Timestamp.Builder	getSubmitTimeBuilder() Time when the operation was submitted.
TimestampOrBuilder	getSubmitTimeOrBuilder() Time when the operation was submitted.
long	getTotalBillableCharacters() Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
long	getTotalBillablePages() Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
long	getTotalCharacters() Total number of characters (Unicode codepoints) in all documents so far.
long	getTotalPages() Total number of pages to translate in all documents so far.
long	getTranslatedCharacters() Number of successfully translated characters (Unicode codepoints) in all documents so far.
long	getTranslatedPages() Number of successfully translated pages in all documents so far.
boolean	hasSubmitTime() Time when the operation was submitted.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
BatchTranslateDocumentMetadata.Builder	mergeFrom(BatchTranslateDocumentMetadata other)
BatchTranslateDocumentMetadata.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
BatchTranslateDocumentMetadata.Builder	mergeFrom(Message other)
BatchTranslateDocumentMetadata.Builder	mergeSubmitTime(Timestamp value) Time when the operation was submitted.
BatchTranslateDocumentMetadata.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
BatchTranslateDocumentMetadata.Builder	setFailedCharacters(long value) Number of characters that have failed to process (Unicode codepoints) in all documents so far.
BatchTranslateDocumentMetadata.Builder	setFailedPages(long value) Number of pages that failed to process in all documents so far.
BatchTranslateDocumentMetadata.Builder	setField(Descriptors.FieldDescriptor field, Object value)
BatchTranslateDocumentMetadata.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
BatchTranslateDocumentMetadata.Builder	setState(BatchTranslateDocumentMetadata.State value) The state of the operation.
BatchTranslateDocumentMetadata.Builder	setStateValue(int value) The state of the operation.
BatchTranslateDocumentMetadata.Builder	setSubmitTime(Timestamp.Builder builderForValue) Time when the operation was submitted.
BatchTranslateDocumentMetadata.Builder	setSubmitTime(Timestamp value) Time when the operation was submitted.
BatchTranslateDocumentMetadata.Builder	setTotalBillableCharacters(long value) Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.
BatchTranslateDocumentMetadata.Builder	setTotalBillablePages(long value) Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.
BatchTranslateDocumentMetadata.Builder	setTotalCharacters(long value) Total number of characters (Unicode codepoints) in all documents so far.
BatchTranslateDocumentMetadata.Builder	setTotalPages(long value) Total number of pages to translate in all documents so far.
BatchTranslateDocumentMetadata.Builder	setTranslatedCharacters(long value) Number of successfully translated characters (Unicode codepoints) in all documents so far.
BatchTranslateDocumentMetadata.Builder	setTranslatedPages(long value) Number of successfully translated pages in all documents so far.
BatchTranslateDocumentMetadata.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

clear

public BatchTranslateDocumentMetadata.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

getDefaultInstanceForType

public BatchTranslateDocumentMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public BatchTranslateDocumentMetadata build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public BatchTranslateDocumentMetadata buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public BatchTranslateDocumentMetadata.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

setField

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

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

clearField

public BatchTranslateDocumentMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

clearOneof

public BatchTranslateDocumentMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

mergeFrom

public BatchTranslateDocumentMetadata.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<BatchTranslateDocumentMetadata.Builder>

mergeFrom

public BatchTranslateDocumentMetadata.Builder mergeFrom(BatchTranslateDocumentMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<BatchTranslateDocumentMetadata.Builder>

Throws:

IOException

getStateValue

public int getStateValue()

 The state of the operation.
 

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

Specified by:

getStateValue in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The enum numeric value on the wire for state.

setStateValue

public BatchTranslateDocumentMetadata.Builder setStateValue(int value)

 The state of the operation.
 

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

Parameters:

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

Returns:

This builder for chaining.

getState

public BatchTranslateDocumentMetadata.State getState()

 The state of the operation.
 

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

Specified by:

getState in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The state.

setState

public BatchTranslateDocumentMetadata.Builder setState(BatchTranslateDocumentMetadata.State value)

 The state of the operation.
 

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

Parameters:

value - The state to set.

Returns:

This builder for chaining.

clearState

public BatchTranslateDocumentMetadata.Builder clearState()

 The state of the operation.
 

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

Returns:

This builder for chaining.

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;

Specified by:

getTotalPages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalPages.

setTotalPages

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;

Parameters:

value - The totalPages to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getTranslatedPages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The translatedPages.

setTranslatedPages

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;

Parameters:

value - The translatedPages to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getFailedPages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The failedPages.

setFailedPages

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;

Parameters:

value - The failedPages to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getTotalBillablePages in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalBillablePages.

setTotalBillablePages

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;

Parameters:

value - The totalBillablePages to set.

Returns:

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:

This builder for chaining.

getTotalCharacters

public long getTotalCharacters()

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

int64 total_characters = 6;

Specified by:

getTotalCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalCharacters.

setTotalCharacters

public BatchTranslateDocumentMetadata.Builder setTotalCharacters(long value)

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

int64 total_characters = 6;

Parameters:

value - The totalCharacters to set.

Returns:

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:

This builder for chaining.

getTranslatedCharacters

public long getTranslatedCharacters()

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

int64 translated_characters = 7;

Specified by:

getTranslatedCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The translatedCharacters.

setTranslatedCharacters

public BatchTranslateDocumentMetadata.Builder setTranslatedCharacters(long value)

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

int64 translated_characters = 7;

Parameters:

value - The translatedCharacters to set.

Returns:

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:

This builder for chaining.

getFailedCharacters

public long getFailedCharacters()

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

int64 failed_characters = 8;

Specified by:

getFailedCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The failedCharacters.

setFailedCharacters

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;

Parameters:

value - The failedCharacters to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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;

Specified by:

getTotalBillableCharacters in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The totalBillableCharacters.

setTotalBillableCharacters

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;

Parameters:

value - The totalBillableCharacters to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

hasSubmitTime

public boolean hasSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Specified by:

hasSubmitTime in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

Whether the submitTime field is set.

getSubmitTime

public Timestamp getSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Specified by:

getSubmitTime in interface BatchTranslateDocumentMetadataOrBuilder

Returns:

The submitTime.

setSubmitTime

public BatchTranslateDocumentMetadata.Builder setSubmitTime(Timestamp value)

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

setSubmitTime

public BatchTranslateDocumentMetadata.Builder setSubmitTime(Timestamp.Builder builderForValue)

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

mergeSubmitTime

public BatchTranslateDocumentMetadata.Builder mergeSubmitTime(Timestamp value)

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

clearSubmitTime

public BatchTranslateDocumentMetadata.Builder clearSubmitTime()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

getSubmitTimeBuilder

public Timestamp.Builder getSubmitTimeBuilder()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

getSubmitTimeOrBuilder

public TimestampOrBuilder getSubmitTimeOrBuilder()

 Time when the operation was submitted.
 

.google.protobuf.Timestamp submit_time = 10;

Specified by:

getSubmitTimeOrBuilder in interface BatchTranslateDocumentMetadataOrBuilder

setUnknownFields

public final BatchTranslateDocumentMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>

mergeUnknownFields

public final BatchTranslateDocumentMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<BatchTranslateDocumentMetadata.Builder>