Class Document.Builder (2.5.0)

Version 2.5.0

• 2.51.0 (latest)
• 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.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.18
• 2.2.3
• 2.1.23

public static final class Document.Builder extends GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilder

A structured text document e.g. a PDF.

Protobuf type google.cloud.automl.v1.Document

Inheritance

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

Implements

DocumentOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addAllLayout(Iterable<? extends Document.Layout> values)

public Document.Builder addAllLayout(Iterable<? extends Document.Layout> values)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.automl.v1.Document.Layout>

Returns

Type	Description
Document.Builder

addLayout(Document.Layout value)

public Document.Builder addLayout(Document.Layout value)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
value	Document.Layout

Returns

Type	Description
Document.Builder

addLayout(Document.Layout.Builder builderForValue)

public Document.Builder addLayout(Document.Layout.Builder builderForValue)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
builderForValue	Document.Layout.Builder

Returns

Type	Description
Document.Builder

addLayout(int index, Document.Layout value)

public Document.Builder addLayout(int index, Document.Layout value)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameters

Name	Description
index	int
value	Document.Layout

Returns

Type	Description
Document.Builder

addLayout(int index, Document.Layout.Builder builderForValue)

public Document.Builder addLayout(int index, Document.Layout.Builder builderForValue)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameters

Name	Description
index	int
builderForValue	Document.Layout.Builder

Returns

Type	Description
Document.Builder

addLayoutBuilder()

public Document.Layout.Builder addLayoutBuilder()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Returns

Type	Description
Document.Layout.Builder

addLayoutBuilder(int index)

public Document.Layout.Builder addLayoutBuilder(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.Layout.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Document.Builder

Overrides

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

build()

public Document build()

Returns

Type	Description
Document

buildPartial()

public Document buildPartial()

Returns

Type	Description
Document

clear()

public Document.Builder clear()

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocumentDimensions()

public Document.Builder clearDocumentDimensions()

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Returns

Type	Description
Document.Builder

clearDocumentText()

public Document.Builder clearDocumentText()

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Returns

Type	Description
Document.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Document.Builder

Overrides

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

clearInputConfig()

public Document.Builder clearInputConfig()

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Returns

Type	Description
Document.Builder

clearLayout()

public Document.Builder clearLayout()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Returns

Type	Description
Document.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
Document.Builder

Overrides

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

clearPageCount()

public Document.Builder clearPageCount()

Number of pages in the document.

int32 page_count = 5;

Returns

Type	Description
Document.Builder	This builder for chaining.

clone()

public Document.Builder clone()

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Document getDefaultInstanceForType()

Returns

Type	Description
Document

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocumentDimensions()

public DocumentDimensions getDocumentDimensions()

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Returns

Type	Description
DocumentDimensions	The documentDimensions.

getDocumentDimensionsBuilder()

public DocumentDimensions.Builder getDocumentDimensionsBuilder()

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Returns

Type	Description
DocumentDimensions.Builder

getDocumentDimensionsOrBuilder()

public DocumentDimensionsOrBuilder getDocumentDimensionsOrBuilder()

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Returns

Type	Description
DocumentDimensionsOrBuilder

getDocumentText()

public TextSnippet getDocumentText()

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Returns

Type	Description
TextSnippet	The documentText.

getDocumentTextBuilder()

public TextSnippet.Builder getDocumentTextBuilder()

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Returns

Type	Description
TextSnippet.Builder

getDocumentTextOrBuilder()

public TextSnippetOrBuilder getDocumentTextOrBuilder()

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Returns

Type	Description
TextSnippetOrBuilder

getInputConfig()

public DocumentInputConfig getInputConfig()

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Returns

Type	Description
DocumentInputConfig	The inputConfig.

getInputConfigBuilder()

public DocumentInputConfig.Builder getInputConfigBuilder()

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Returns

Type	Description
DocumentInputConfig.Builder

getInputConfigOrBuilder()

public DocumentInputConfigOrBuilder getInputConfigOrBuilder()

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Returns

Type	Description
DocumentInputConfigOrBuilder

getLayout(int index)

public Document.Layout getLayout(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.Layout

getLayoutBuilder(int index)

public Document.Layout.Builder getLayoutBuilder(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.Layout.Builder

getLayoutBuilderList()

public List<Document.Layout.Builder> getLayoutBuilderList()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Returns

Type	Description
List<Builder>

getLayoutCount()

public int getLayoutCount()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Returns

Type	Description
int

getLayoutList()

public List<Document.Layout> getLayoutList()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Returns

Type	Description
List<Layout>

getLayoutOrBuilder(int index)

public Document.LayoutOrBuilder getLayoutOrBuilder(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.LayoutOrBuilder

getLayoutOrBuilderList()

public List<? extends Document.LayoutOrBuilder> getLayoutOrBuilderList()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Returns

Type	Description
List<? extends com.google.cloud.automl.v1.Document.LayoutOrBuilder>

getPageCount()

public int getPageCount()

Number of pages in the document.

int32 page_count = 5;

Returns

Type	Description
int	The pageCount.

hasDocumentDimensions()

public boolean hasDocumentDimensions()

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Returns

Type	Description
boolean	Whether the documentDimensions field is set.

hasDocumentText()

public boolean hasDocumentText()

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Returns

Type	Description
boolean	Whether the documentText field is set.

hasInputConfig()

public boolean hasInputConfig()

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Returns

Type	Description
boolean	Whether the inputConfig 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()

mergeDocumentDimensions(DocumentDimensions value)

public Document.Builder mergeDocumentDimensions(DocumentDimensions value)

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Parameter

Name	Description
value	DocumentDimensions

Returns

Type	Description
Document.Builder

mergeDocumentText(TextSnippet value)

public Document.Builder mergeDocumentText(TextSnippet value)

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Parameter

Name	Description
value	TextSnippet

Returns

Type	Description
Document.Builder

mergeFrom(Document other)

public Document.Builder mergeFrom(Document other)

Parameter

Name	Description
other	Document

Returns

Type	Description
Document.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Document.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Document.Builder

Overrides

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

mergeInputConfig(DocumentInputConfig value)

public Document.Builder mergeInputConfig(DocumentInputConfig value)

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Parameter

Name	Description
value	DocumentInputConfig

Returns

Type	Description
Document.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Document.Builder

Overrides

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

removeLayout(int index)

public Document.Builder removeLayout(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.Builder

setDocumentDimensions(DocumentDimensions value)

public Document.Builder setDocumentDimensions(DocumentDimensions value)

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Parameter

Name	Description
value	DocumentDimensions

Returns

Type	Description
Document.Builder

setDocumentDimensions(DocumentDimensions.Builder builderForValue)

public Document.Builder setDocumentDimensions(DocumentDimensions.Builder builderForValue)

The dimensions of the page in the document.

.google.cloud.automl.v1.DocumentDimensions document_dimensions = 4;

Parameter

Name	Description
builderForValue	DocumentDimensions.Builder

Returns

Type	Description
Document.Builder

setDocumentText(TextSnippet value)

public Document.Builder setDocumentText(TextSnippet value)

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Parameter

Name	Description
value	TextSnippet

Returns

Type	Description
Document.Builder

setDocumentText(TextSnippet.Builder builderForValue)

public Document.Builder setDocumentText(TextSnippet.Builder builderForValue)

The plain text version of this document.

.google.cloud.automl.v1.TextSnippet document_text = 2;

Parameter

Name	Description
builderForValue	TextSnippet.Builder

Returns

Type	Description
Document.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Document.Builder

Overrides

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

setInputConfig(DocumentInputConfig value)

public Document.Builder setInputConfig(DocumentInputConfig value)

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Parameter

Name	Description
value	DocumentInputConfig

Returns

Type	Description
Document.Builder

setInputConfig(DocumentInputConfig.Builder builderForValue)

public Document.Builder setInputConfig(DocumentInputConfig.Builder builderForValue)

An input config specifying the content of the document.

.google.cloud.automl.v1.DocumentInputConfig input_config = 1;

Parameter

Name	Description
builderForValue	DocumentInputConfig.Builder

Returns

Type	Description
Document.Builder

setLayout(int index, Document.Layout value)

public Document.Builder setLayout(int index, Document.Layout value)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameters

Name	Description
index	int
value	Document.Layout

Returns

Type	Description
Document.Builder

setLayout(int index, Document.Layout.Builder builderForValue)

public Document.Builder setLayout(int index, Document.Layout.Builder builderForValue)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1.Document.Layout layout = 3;

Parameters

Name	Description
index	int
builderForValue	Document.Layout.Builder

Returns

Type	Description
Document.Builder

setPageCount(int value)

public Document.Builder setPageCount(int value)

Number of pages in the document.

int32 page_count = 5;

Parameter

Name	Description
value	int The pageCount to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
Document.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Document.Builder

Overrides

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