Class Document.Page.FormField (2.47.0)

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

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

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

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

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

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