Class Document.Page.FormField (2.16.0)
2.91.0 (latest)
2.89.0
2.87.0
2.86.0
2.85.0
2.84.0
2.82.0
2.80.0
2.79.0
2.78.0
2.77.0
2.76.0
2.74.0
2.72.0
2.71.0
2.68.0
2.67.0
2.66.0
2.64.0
2.63.0
2.62.0
2.61.0
2.60.0
2.59.0
2.58.0
2.57.0
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.v1beta1.Document.Page.FormField
Static Fields
FIELD_NAME_FIELD_NUMBER
public static final int FIELD_NAME_FIELD_NUMBER
Field Value
FIELD_VALUE_FIELD_NUMBER
public static final int FIELD_VALUE_FIELD_NUMBER
Field Value
NAME_DETECTED_LANGUAGES_FIELD_NUMBER
public static final int NAME_DETECTED_LANGUAGES_FIELD_NUMBER
Field Value
VALUE_DETECTED_LANGUAGES_FIELD_NUMBER
public static final int VALUE_DETECTED_LANGUAGES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document . Page . FormField getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Document . Page . FormField . Builder newBuilder ()
Returns
newBuilder(Document.Page.FormField prototype)
public static Document . Page . FormField . Builder newBuilder ( Document . Page . FormField prototype )
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static Document . Page . FormField parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document . Page . FormField parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document . Page . FormField parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document . Page . FormField parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document . Page . FormField parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document . Page . FormField parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static Document . Page . FormField parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Document . Page . FormField parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static Document . Page . FormField parseFrom ( InputStream input )
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document . Page . FormField parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document . Page . FormField parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document . Page . FormField parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Document . Page . FormField > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Document . Page . FormField getDefaultInstanceForType ()
Returns
getFieldName()
public Document . Page . Layout getFieldName ()
Layout for the
FormField
name. e.g. Address, Email, Grand total, Phone number, etc.
.google.cloud.documentai.v1beta1.Document.Page.Layout field_name = 1;
Returns
getFieldNameOrBuilder()
public Document . Page . LayoutOrBuilder getFieldNameOrBuilder ()
Layout for the
FormField
name. e.g. Address, Email, Grand total, Phone number, etc.
.google.cloud.documentai.v1beta1.Document.Page.Layout field_name = 1;
Returns
getFieldValue()
public Document . Page . Layout getFieldValue ()
Layout for the
FormField
value.
.google.cloud.documentai.v1beta1.Document.Page.Layout field_value = 2;
Returns
getFieldValueOrBuilder()
public Document . Page . LayoutOrBuilder getFieldValueOrBuilder ()
Layout for the
FormField
value.
.google.cloud.documentai.v1beta1.Document.Page.Layout field_value = 2;
Returns
getNameDetectedLanguages(int index)
public Document . Page . DetectedLanguage getNameDetectedLanguages ( int index )
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;
Parameter
Name
Description
index
int
Returns
getNameDetectedLanguagesCount()
public int getNameDetectedLanguagesCount ()
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;
Returns
getNameDetectedLanguagesList()
public List<Document . Page . DetectedLanguage > getNameDetectedLanguagesList ()
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;
Returns
getNameDetectedLanguagesOrBuilder(int index)
public Document . Page . DetectedLanguageOrBuilder getNameDetectedLanguagesOrBuilder ( int index )
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;
Parameter
Name
Description
index
int
Returns
getNameDetectedLanguagesOrBuilderList()
public List <? extends Document . Page . DetectedLanguageOrBuilder > getNameDetectedLanguagesOrBuilderList ()
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;
Returns
Type
Description
List <? extends com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguageOrBuilder >
getParserForType()
public Parser<Document . Page . FormField > getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;
Parameter
Name
Description
index
int
Returns
getValueDetectedLanguagesCount()
public int getValueDetectedLanguagesCount ()
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;
Returns
getValueDetectedLanguagesList()
public List<Document . Page . DetectedLanguage > getValueDetectedLanguagesList ()
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;
Returns
getValueDetectedLanguagesOrBuilder(int index)
public Document . Page . DetectedLanguageOrBuilder getValueDetectedLanguagesOrBuilder ( int index )
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;
Parameter
Name
Description
index
int
Returns
getValueDetectedLanguagesOrBuilderList()
public List <? extends Document . Page . DetectedLanguageOrBuilder > getValueDetectedLanguagesOrBuilderList ()
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;
Returns
Type
Description
List <? extends com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguageOrBuilder >
hasFieldName()
public boolean hasFieldName ()
Layout for the
FormField
name. e.g. Address, Email, Grand total, Phone number, etc.
.google.cloud.documentai.v1beta1.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.v1beta1.Document.Page.Layout field_value = 2;
Returns
Type
Description
boolean
Whether the fieldValue field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Document . Page . FormField . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . Page . FormField . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Document . Page . FormField . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]