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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Document.Page.FormField.Builder newBuilder()
newBuilder(Document.Page.FormField prototype)
public static Document.Page.FormField.Builder newBuilder(Document.Page.FormField prototype)
parseDelimitedFrom(InputStream input)
public static Document.Page.FormField parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.Page.FormField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Document.Page.FormField parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document.Page.FormField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Document.Page.FormField parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document.Page.FormField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static Document.Page.FormField parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.Page.FormField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static Document.Page.FormField parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.Page.FormField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Document.Page.FormField parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document.Page.FormField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Document.Page.FormField> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
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()
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;
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;
getFieldValue()
public Document.Page.Layout getFieldValue()
Layout for the FormField value.
.google.cloud.documentai.v1.Document.Page.Layout field_value = 2;
getFieldValueOrBuilder()
public Document.Page.LayoutOrBuilder getFieldValueOrBuilder()
Layout for the FormField value.
.google.cloud.documentai.v1.Document.Page.Layout field_value = 2;
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
|
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;
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
|
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()
Overrides
getProvenance()
public Document.Provenance getProvenance()
The history of this annotation.
.google.cloud.documentai.v1.Document.Provenance provenance = 8;
getProvenanceOrBuilder()
public Document.ProvenanceOrBuilder getProvenanceOrBuilder()
The history of this annotation.
.google.cloud.documentai.v1.Document.Provenance provenance = 8;
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
|
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;
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
|
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()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Document.Page.FormField.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Page.FormField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public Document.Page.FormField.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides