Class Document.Page.VisualElement (2.11.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
TypeDescription
int

LAYOUT_FIELD_NUMBER

public static final int LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Page.VisualElement getDefaultInstance()
Returns
TypeDescription
Document.Page.VisualElement

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Document.Page.VisualElement.Builder newBuilder()
Returns
TypeDescription
Document.Page.VisualElement.Builder

newBuilder(Document.Page.VisualElement prototype)

public static Document.Page.VisualElement.Builder newBuilder(Document.Page.VisualElement prototype)
Parameter
NameDescription
prototypeDocument.Page.VisualElement
Returns
TypeDescription
Document.Page.VisualElement.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page.VisualElement parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Page.VisualElement parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.VisualElement parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.VisualElement parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Page.VisualElement parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Page.VisualElement parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.VisualElement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.VisualElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Document.Page.VisualElement getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Document.Page.Layout

The layout.

getLayoutOrBuilder()

public Document.Page.LayoutOrBuilder getLayoutOrBuilder()

Layout for VisualElement.

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

Returns
TypeDescription
Document.Page.LayoutOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public String getType()

Type of the VisualElement.

string type = 2;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Type of the VisualElement.

string type = 2;

Returns
TypeDescription
ByteString

The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasLayout()

public boolean hasLayout()

Layout for VisualElement.

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

Returns
TypeDescription
boolean

Whether the layout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.Page.VisualElement.Builder newBuilderForType()
Returns
TypeDescription
Document.Page.VisualElement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.VisualElement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Page.VisualElement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.Page.VisualElement.Builder toBuilder()
Returns
TypeDescription
Document.Page.VisualElement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException