Class Document.Page.VisualElement (2.56.0)

public static final class Document.Page.VisualElement extends GeneratedMessageV3 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 Fields

DETECTED_LANGUAGES_FIELD_NUMBER

public static final int DETECTED_LANGUAGES_FIELD_NUMBER
Field Value
Type Description
int

LAYOUT_FIELD_NUMBER

public static final int LAYOUT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.Page.VisualElement getDefaultInstance()
Returns
Type Description
Document.Page.VisualElement

getDescriptor()

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

newBuilder()

public static Document.Page.VisualElement.Builder newBuilder()
Returns
Type Description
Document.Page.VisualElement.Builder

newBuilder(Document.Page.VisualElement prototype)

public static Document.Page.VisualElement.Builder newBuilder(Document.Page.VisualElement prototype)
Parameter
Name Description
prototype Document.Page.VisualElement
Returns
Type Description
Document.Page.VisualElement.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page.VisualElement parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.Page.VisualElement parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.VisualElement parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.VisualElement parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.Page.VisualElement parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.Page.VisualElement parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.VisualElement
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Page.VisualElement> parser()
Returns
Type Description
Parser<VisualElement>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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

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.

getLayoutOrBuilder()

public Document.Page.LayoutOrBuilder getLayoutOrBuilder()

Layout for VisualElement.

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

Returns
Type Description
Document.Page.LayoutOrBuilder

getParserForType()

public Parser<Document.Page.VisualElement> getParserForType()
Returns
Type Description
Parser<VisualElement>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.Page.VisualElement.Builder newBuilderForType()
Returns
Type Description
Document.Page.VisualElement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.VisualElement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.Page.VisualElement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.Page.VisualElement.Builder toBuilder()
Returns
Type Description
Document.Page.VisualElement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException