Class Document.Page.FormField (2.57.0)

Version latest

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.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.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static final class Document.Page.FormField extends GeneratedMessageV3 implements Document.Page.FormFieldOrBuilder

A form field detected on the page.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.Page.FormField

Implements

Document.Page.FormFieldOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CORRECTED_KEY_TEXT_FIELD_NUMBER

public static final int CORRECTED_KEY_TEXT_FIELD_NUMBER

Field Value
Type	Description
int

CORRECTED_VALUE_TEXT_FIELD_NUMBER

public static final int CORRECTED_VALUE_TEXT_FIELD_NUMBER

Field Value
Type	Description
int

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER

Field Value
Type	Description
int

FIELD_VALUE_FIELD_NUMBER

public static final int FIELD_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

NAME_DETECTED_LANGUAGES_FIELD_NUMBER

public static final int NAME_DETECTED_LANGUAGES_FIELD_NUMBER

Field Value
Type	Description
int

PROVENANCE_FIELD_NUMBER

public static final int PROVENANCE_FIELD_NUMBER

Field Value
Type	Description
int

VALUE_DETECTED_LANGUAGES_FIELD_NUMBER

public static final int VALUE_DETECTED_LANGUAGES_FIELD_NUMBER

Field Value
Type	Description
int

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Document.Page.FormField getDefaultInstance()

Returns
Type	Description
Document.Page.FormField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Document.Page.FormField.Builder newBuilder()

Returns
Type	Description
Document.Page.FormField.Builder

newBuilder(Document.Page.FormField prototype)

public static Document.Page.FormField.Builder newBuilder(Document.Page.FormField prototype)

Parameter
Name	Description
prototype	Document.Page.FormField

Returns
Type	Description
Document.Page.FormField.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page.FormField parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.FormField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Document.Page.FormField parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.FormField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.FormField parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.FormField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.FormField parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.FormField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Document.Page.FormField parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.FormField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document.Page.FormField parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.FormField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.FormField

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Page.FormField> parser()

Returns
Type	Description
Parser<FormField>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCorrectedKeyText()

public String getCorrectedKeyText()

Created for Labeling UI to export key text. If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.

string corrected_key_text = 6;

Returns
Type	Description
String	The correctedKeyText.

getCorrectedKeyTextBytes()

public ByteString getCorrectedKeyTextBytes()

Created for Labeling UI to export key text. If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.

string corrected_key_text = 6;

Returns
Type	Description
ByteString	The bytes for correctedKeyText.

getCorrectedValueText()

public String getCorrectedValueText()

Created for Labeling UI to export value text. If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.

string corrected_value_text = 7;

Returns
Type	Description
String	The correctedValueText.

getCorrectedValueTextBytes()

public ByteString getCorrectedValueTextBytes()

Created for Labeling UI to export value text. If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.

string corrected_value_text = 7;

Returns
Type	Description
ByteString	The bytes for correctedValueText.

getDefaultInstanceForType()

public Document.Page.FormField getDefaultInstanceForType()

Returns
Type	Description
Document.Page.FormField

getFieldName()

public Document.Page.Layout getFieldName()

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

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

Returns
Type	Description
Document.Page.Layout	The fieldName.

getFieldNameOrBuilder()

public Document.Page.LayoutOrBuilder getFieldNameOrBuilder()

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

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

Returns
Type	Description
Document.Page.LayoutOrBuilder

getFieldValue()

public Document.Page.Layout getFieldValue()

Layout for the FormField value.

.google.cloud.documentai.v1.Document.Page.Layout field_value = 2;

Returns
Type	Description
Document.Page.Layout	The fieldValue.

getFieldValueOrBuilder()

public Document.Page.LayoutOrBuilder getFieldValueOrBuilder()

Layout for the FormField value.

.google.cloud.documentai.v1.Document.Page.Layout field_value = 2;

Returns
Type	Description
Document.Page.LayoutOrBuilder

getNameDetectedLanguages(int index)

public Document.Page.DetectedLanguage getNameDetectedLanguages(int index)

A list of detected languages for name together with confidence.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguage

getNameDetectedLanguagesCount()

public int getNameDetectedLanguagesCount()

A list of detected languages for name together with confidence.

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

Returns
Type	Description
int

getNameDetectedLanguagesList()

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

A list of detected languages for name together with confidence.

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

Returns
Type	Description
List<DetectedLanguage>

getNameDetectedLanguagesOrBuilder(int index)

public Document.Page.DetectedLanguageOrBuilder getNameDetectedLanguagesOrBuilder(int index)

A list of detected languages for name together with confidence.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguageOrBuilder

getNameDetectedLanguagesOrBuilderList()

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

A list of detected languages for name together with confidence.

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

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

getParserForType()

public Parser<Document.Page.FormField> getParserForType()

Returns
Type	Description
Parser<FormField>

Overrides

GeneratedMessageV3.getParserForType()

getProvenance()

public Document.Provenance getProvenance()

The history of this annotation.

.google.cloud.documentai.v1.Document.Provenance provenance = 8;

Returns
Type	Description
Document.Provenance	The provenance.

getProvenanceOrBuilder()

public Document.ProvenanceOrBuilder getProvenanceOrBuilder()

The history of this annotation.

.google.cloud.documentai.v1.Document.Provenance provenance = 8;

Returns
Type	Description
Document.ProvenanceOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getValueDetectedLanguages(int index)

public Document.Page.DetectedLanguage getValueDetectedLanguages(int index)

A list of detected languages for value together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguage

getValueDetectedLanguagesCount()

public int getValueDetectedLanguagesCount()

A list of detected languages for value together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Returns
Type	Description
int

getValueDetectedLanguagesList()

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

A list of detected languages for value together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Returns
Type	Description
List<DetectedLanguage>

getValueDetectedLanguagesOrBuilder(int index)

public Document.Page.DetectedLanguageOrBuilder getValueDetectedLanguagesOrBuilder(int index)

A list of detected languages for value together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguageOrBuilder

getValueDetectedLanguagesOrBuilderList()

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

A list of detected languages for value together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

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

getValueType()

public String getValueType()

If the value is non-textual, this field represents the type. Current valid values are:

• blank (this indicates the field_value is normal text)
• unfilled_checkbox
• filled_checkbox

string value_type = 5;

Returns
Type	Description
String	The valueType.

getValueTypeBytes()

public ByteString getValueTypeBytes()

If the value is non-textual, this field represents the type. Current valid values are:

• blank (this indicates the field_value is normal text)
• unfilled_checkbox
• filled_checkbox

string value_type = 5;

Returns
Type	Description
ByteString	The bytes for valueType.

hasFieldName()

public boolean hasFieldName()

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

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

Returns
Type	Description
boolean	Whether the fieldName field is set.

hasFieldValue()

public boolean hasFieldValue()

Layout for the FormField value.

.google.cloud.documentai.v1.Document.Page.Layout field_value = 2;

Returns
Type	Description
boolean	Whether the fieldValue field is set.

hasProvenance()

public boolean hasProvenance()

The history of this annotation.

.google.cloud.documentai.v1.Document.Provenance provenance = 8;

Returns
Type	Description
boolean	Whether the provenance field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Document.Page.FormField.Builder newBuilderForType()

Returns
Type	Description
Document.Page.FormField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.FormField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Document.Page.FormField.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Document.Page.FormField.Builder toBuilder()

Returns
Type	Description
Document.Page.FormField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException