Class Document.Page.VisualElement.Builder (2.46.0)

public static final class Document.Page.VisualElement.Builder extends GeneratedMessageV3.Builder<Document.Page.VisualElement.Builder> implements Document.Page.VisualElementOrBuilder

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

Protobuf type google.cloud.documentai.v1.Document.Page.VisualElement

Static Methods

getDescriptor()

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

Methods

addAllDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

public Document.Page.VisualElement.Builder addAllDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguage>
Returns
Type Description
Document.Page.VisualElement.Builder

addDetectedLanguages(Document.Page.DetectedLanguage value)

public Document.Page.VisualElement.Builder addDetectedLanguages(Document.Page.DetectedLanguage value)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
value Document.Page.DetectedLanguage
Returns
Type Description
Document.Page.VisualElement.Builder

addDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.VisualElement.Builder addDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
Document.Page.VisualElement.Builder

addDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.VisualElement.Builder addDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameters
Name Description
index int
value Document.Page.DetectedLanguage
Returns
Type Description
Document.Page.VisualElement.Builder

addDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.VisualElement.Builder addDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameters
Name Description
index int
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
Document.Page.VisualElement.Builder

addDetectedLanguagesBuilder()

public Document.Page.DetectedLanguage.Builder addDetectedLanguagesBuilder()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type Description
Document.Page.DetectedLanguage.Builder

addDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder addDetectedLanguagesBuilder(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
Document.Page.DetectedLanguage.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Document.Page.VisualElement build()
Returns
Type Description
Document.Page.VisualElement

buildPartial()

public Document.Page.VisualElement buildPartial()
Returns
Type Description
Document.Page.VisualElement

clear()

public Document.Page.VisualElement.Builder clear()
Returns
Type Description
Document.Page.VisualElement.Builder
Overrides

clearDetectedLanguages()

public Document.Page.VisualElement.Builder clearDetectedLanguages()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type Description
Document.Page.VisualElement.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Page.VisualElement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Document.Page.VisualElement.Builder
Overrides

clearLayout()

public Document.Page.VisualElement.Builder clearLayout()

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
Type Description
Document.Page.VisualElement.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Page.VisualElement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Page.VisualElement.Builder
Overrides

clearType()

public Document.Page.VisualElement.Builder clearType()

Type of the VisualElement.

string type = 2;

Returns
Type Description
Document.Page.VisualElement.Builder

This builder for chaining.

clone()

public Document.Page.VisualElement.Builder clone()
Returns
Type Description
Document.Page.VisualElement.Builder
Overrides

getDefaultInstanceForType()

public Document.Page.VisualElement getDefaultInstanceForType()
Returns
Type Description
Document.Page.VisualElement

getDescriptorForType()

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

getDetectedLanguages(int index)

public Document.Page.DetectedLanguage getDetectedLanguages(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
Document.Page.DetectedLanguage

getDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder getDetectedLanguagesBuilder(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
Document.Page.DetectedLanguage.Builder

getDetectedLanguagesBuilderList()

public List<Document.Page.DetectedLanguage.Builder> getDetectedLanguagesBuilderList()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type Description
List<Builder>

getDetectedLanguagesCount()

public int getDetectedLanguagesCount()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type Description
int

getDetectedLanguagesList()

public List<Document.Page.DetectedLanguage> getDetectedLanguagesList()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type Description
List<DetectedLanguage>

getDetectedLanguagesOrBuilder(int index)

public Document.Page.DetectedLanguageOrBuilder getDetectedLanguagesOrBuilder(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
Document.Page.DetectedLanguageOrBuilder

getDetectedLanguagesOrBuilderList()

public List<? extends Document.Page.DetectedLanguageOrBuilder> getDetectedLanguagesOrBuilderList()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguageOrBuilder>

getLayout()

public Document.Page.Layout getLayout()

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
Type Description
Document.Page.Layout

The layout.

getLayoutBuilder()

public Document.Page.Layout.Builder getLayoutBuilder()

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
Type Description
Document.Page.Layout.Builder

getLayoutOrBuilder()

public Document.Page.LayoutOrBuilder getLayoutOrBuilder()

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
Type Description
Document.Page.LayoutOrBuilder

getType()

public String getType()

Type of the VisualElement.

string type = 2;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Type of the VisualElement.

string type = 2;

Returns
Type Description
ByteString

The bytes for type.

hasLayout()

public boolean hasLayout()

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Returns
Type Description
boolean

Whether the layout field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Document.Page.VisualElement other)

public Document.Page.VisualElement.Builder mergeFrom(Document.Page.VisualElement other)
Parameter
Name Description
other Document.Page.VisualElement
Returns
Type Description
Document.Page.VisualElement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeLayout(Document.Page.Layout value)

public Document.Page.VisualElement.Builder mergeLayout(Document.Page.Layout value)

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Parameter
Name Description
value Document.Page.Layout
Returns
Type Description
Document.Page.VisualElement.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.VisualElement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Page.VisualElement.Builder
Overrides

removeDetectedLanguages(int index)

public Document.Page.VisualElement.Builder removeDetectedLanguages(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
Document.Page.VisualElement.Builder

setDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.VisualElement.Builder setDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameters
Name Description
index int
value Document.Page.DetectedLanguage
Returns
Type Description
Document.Page.VisualElement.Builder

setDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.VisualElement.Builder setDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 3;

Parameters
Name Description
index int
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
Document.Page.VisualElement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setLayout(Document.Page.Layout value)

public Document.Page.VisualElement.Builder setLayout(Document.Page.Layout value)

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Parameter
Name Description
value Document.Page.Layout
Returns
Type Description
Document.Page.VisualElement.Builder

setLayout(Document.Page.Layout.Builder builderForValue)

public Document.Page.VisualElement.Builder setLayout(Document.Page.Layout.Builder builderForValue)

Layout for VisualElement.

.google.cloud.documentai.v1.Document.Page.Layout layout = 1;

Parameter
Name Description
builderForValue Document.Page.Layout.Builder
Returns
Type Description
Document.Page.VisualElement.Builder

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

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

setType(String value)

public Document.Page.VisualElement.Builder setType(String value)

Type of the VisualElement.

string type = 2;

Parameter
Name Description
value String

The type to set.

Returns
Type Description
Document.Page.VisualElement.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public Document.Page.VisualElement.Builder setTypeBytes(ByteString value)

Type of the VisualElement.

string type = 2;

Parameter
Name Description
value ByteString

The bytes for type to set.

Returns
Type Description
Document.Page.VisualElement.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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