Class Document.Builder (2.55.0)

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

Implements

DocumentOrBuilder

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

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

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

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

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

getDefaultInstanceForType()

public Document getDefaultInstanceForType()
Returns
Type Description
Document

getDescriptorForType()

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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