public static final class Document.Page.FormField extends com.google.protobuf.GeneratedMessageV3 implements Document.Page.FormFieldOrBuilder
A form field detected on the page.Protobuf type
google.cloud.documentai.v1beta2.Document.Page.FormField| Modifier and Type | Class and Description |
|---|---|
static class |
Document.Page.FormField.Builder
A form field detected on the page.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CORRECTED_KEY_TEXT_FIELD_NUMBER |
static int |
CORRECTED_VALUE_TEXT_FIELD_NUMBER |
static int |
FIELD_NAME_FIELD_NUMBER |
static int |
FIELD_VALUE_FIELD_NUMBER |
static int |
NAME_DETECTED_LANGUAGES_FIELD_NUMBER |
static int |
PROVENANCE_FIELD_NUMBER |
static int |
VALUE_DETECTED_LANGUAGES_FIELD_NUMBER |
static int |
VALUE_TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getCorrectedKeyText()
Created for Labeling UI to export key text.
|
com.google.protobuf.ByteString |
getCorrectedKeyTextBytes()
Created for Labeling UI to export key text.
|
String |
getCorrectedValueText()
Created for Labeling UI to export value text.
|
com.google.protobuf.ByteString |
getCorrectedValueTextBytes()
Created for Labeling UI to export value text.
|
static Document.Page.FormField |
getDefaultInstance() |
Document.Page.FormField |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Document.Page.Layout |
getFieldName()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
[FormField][google.cloud.documentai.v1beta2.Document.Page.FormField]
name.
|
Document.Page.LayoutOrBuilder |
getFieldNameOrBuilder()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
[FormField][google.cloud.documentai.v1beta2.Document.Page.FormField]
name.
|
Document.Page.Layout |
getFieldValue()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
[FormField][google.cloud.documentai.v1beta2.Document.Page.FormField]
value.
|
Document.Page.LayoutOrBuilder |
getFieldValueOrBuilder()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
[FormField][google.cloud.documentai.v1beta2.Document.Page.FormField]
value.
|
Document.Page.DetectedLanguage |
getNameDetectedLanguages(int index)
A list of detected languages for name together with confidence.
|
int |
getNameDetectedLanguagesCount()
A list of detected languages for name together with confidence.
|
List<Document.Page.DetectedLanguage> |
getNameDetectedLanguagesList()
A list of detected languages for name together with confidence.
|
Document.Page.DetectedLanguageOrBuilder |
getNameDetectedLanguagesOrBuilder(int index)
A list of detected languages for name together with confidence.
|
List<? extends Document.Page.DetectedLanguageOrBuilder> |
getNameDetectedLanguagesOrBuilderList()
A list of detected languages for name together with confidence.
|
com.google.protobuf.Parser<Document.Page.FormField> |
getParserForType() |
Document.Provenance |
getProvenance()
The history of this annotation.
|
Document.ProvenanceOrBuilder |
getProvenanceOrBuilder()
The history of this annotation.
|
int |
getSerializedSize() |
Document.Page.DetectedLanguage |
getValueDetectedLanguages(int index)
A list of detected languages for value together with confidence.
|
int |
getValueDetectedLanguagesCount()
A list of detected languages for value together with confidence.
|
List<Document.Page.DetectedLanguage> |
getValueDetectedLanguagesList()
A list of detected languages for value together with confidence.
|
Document.Page.DetectedLanguageOrBuilder |
getValueDetectedLanguagesOrBuilder(int index)
A list of detected languages for value together with confidence.
|
List<? extends Document.Page.DetectedLanguageOrBuilder> |
getValueDetectedLanguagesOrBuilderList()
A list of detected languages for value together with confidence.
|
String |
getValueType()
If the value is non-textual, this field represents the type.
|
com.google.protobuf.ByteString |
getValueTypeBytes()
If the value is non-textual, this field represents the type.
|
boolean |
hasFieldName()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
[FormField][google.cloud.documentai.v1beta2.Document.Page.FormField]
name.
|
boolean |
hasFieldValue()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
[FormField][google.cloud.documentai.v1beta2.Document.Page.FormField]
value.
|
int |
hashCode() |
boolean |
hasProvenance()
The history of this annotation.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Document.Page.FormField.Builder |
newBuilder() |
static Document.Page.FormField.Builder |
newBuilder(Document.Page.FormField prototype) |
Document.Page.FormField.Builder |
newBuilderForType() |
protected Document.Page.FormField.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Document.Page.FormField |
parseDelimitedFrom(InputStream input) |
static Document.Page.FormField |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Page.FormField |
parseFrom(byte[] data) |
static Document.Page.FormField |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Page.FormField |
parseFrom(ByteBuffer data) |
static Document.Page.FormField |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Page.FormField |
parseFrom(com.google.protobuf.ByteString data) |
static Document.Page.FormField |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Page.FormField |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Document.Page.FormField |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Page.FormField |
parseFrom(InputStream input) |
static Document.Page.FormField |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Document.Page.FormField> |
parser() |
Document.Page.FormField.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int FIELD_NAME_FIELD_NUMBER
public static final int FIELD_VALUE_FIELD_NUMBER
public static final int NAME_DETECTED_LANGUAGES_FIELD_NUMBER
public static final int VALUE_DETECTED_LANGUAGES_FIELD_NUMBER
public static final int VALUE_TYPE_FIELD_NUMBER
public static final int CORRECTED_KEY_TEXT_FIELD_NUMBER
public static final int CORRECTED_VALUE_TEXT_FIELD_NUMBER
public static final int PROVENANCE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasFieldName()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta2.Document.Page.FormField] name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
.google.cloud.documentai.v1beta2.Document.Page.Layout field_name = 1;hasFieldName in interface Document.Page.FormFieldOrBuilderpublic Document.Page.Layout getFieldName()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta2.Document.Page.FormField] name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
.google.cloud.documentai.v1beta2.Document.Page.Layout field_name = 1;getFieldName in interface Document.Page.FormFieldOrBuilderpublic Document.Page.LayoutOrBuilder getFieldNameOrBuilder()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta2.Document.Page.FormField] name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
.google.cloud.documentai.v1beta2.Document.Page.Layout field_name = 1;getFieldNameOrBuilder in interface Document.Page.FormFieldOrBuilderpublic boolean hasFieldValue()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta2.Document.Page.FormField] value.
.google.cloud.documentai.v1beta2.Document.Page.Layout field_value = 2;hasFieldValue in interface Document.Page.FormFieldOrBuilderpublic Document.Page.Layout getFieldValue()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta2.Document.Page.FormField] value.
.google.cloud.documentai.v1beta2.Document.Page.Layout field_value = 2;getFieldValue in interface Document.Page.FormFieldOrBuilderpublic Document.Page.LayoutOrBuilder getFieldValueOrBuilder()
[Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta2.Document.Page.FormField] value.
.google.cloud.documentai.v1beta2.Document.Page.Layout field_value = 2;getFieldValueOrBuilder in interface Document.Page.FormFieldOrBuilderpublic List<Document.Page.DetectedLanguage> getNameDetectedLanguagesList()
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage name_detected_languages = 3;
getNameDetectedLanguagesList in interface Document.Page.FormFieldOrBuilderpublic List<? extends Document.Page.DetectedLanguageOrBuilder> getNameDetectedLanguagesOrBuilderList()
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage name_detected_languages = 3;
getNameDetectedLanguagesOrBuilderList in interface Document.Page.FormFieldOrBuilderpublic int getNameDetectedLanguagesCount()
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage name_detected_languages = 3;
getNameDetectedLanguagesCount in interface Document.Page.FormFieldOrBuilderpublic Document.Page.DetectedLanguage getNameDetectedLanguages(int index)
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage name_detected_languages = 3;
getNameDetectedLanguages in interface Document.Page.FormFieldOrBuilderpublic Document.Page.DetectedLanguageOrBuilder getNameDetectedLanguagesOrBuilder(int index)
A list of detected languages for name together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage name_detected_languages = 3;
getNameDetectedLanguagesOrBuilder in interface Document.Page.FormFieldOrBuilderpublic List<Document.Page.DetectedLanguage> getValueDetectedLanguagesList()
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage value_detected_languages = 4;
getValueDetectedLanguagesList in interface Document.Page.FormFieldOrBuilderpublic List<? extends Document.Page.DetectedLanguageOrBuilder> getValueDetectedLanguagesOrBuilderList()
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage value_detected_languages = 4;
getValueDetectedLanguagesOrBuilderList in interface Document.Page.FormFieldOrBuilderpublic int getValueDetectedLanguagesCount()
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage value_detected_languages = 4;
getValueDetectedLanguagesCount in interface Document.Page.FormFieldOrBuilderpublic Document.Page.DetectedLanguage getValueDetectedLanguages(int index)
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage value_detected_languages = 4;
getValueDetectedLanguages in interface Document.Page.FormFieldOrBuilderpublic Document.Page.DetectedLanguageOrBuilder getValueDetectedLanguagesOrBuilder(int index)
A list of detected languages for value together with confidence.
repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage value_detected_languages = 4;
getValueDetectedLanguagesOrBuilder in interface Document.Page.FormFieldOrBuilderpublic 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;getValueType in interface Document.Page.FormFieldOrBuilderpublic com.google.protobuf.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;getValueTypeBytes in interface Document.Page.FormFieldOrBuilderpublic 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;getCorrectedKeyText in interface Document.Page.FormFieldOrBuilderpublic com.google.protobuf.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;getCorrectedKeyTextBytes in interface Document.Page.FormFieldOrBuilderpublic 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;getCorrectedValueText in interface Document.Page.FormFieldOrBuilderpublic com.google.protobuf.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;getCorrectedValueTextBytes in interface Document.Page.FormFieldOrBuilderpublic boolean hasProvenance()
The history of this annotation.
.google.cloud.documentai.v1beta2.Document.Provenance provenance = 8;hasProvenance in interface Document.Page.FormFieldOrBuilderpublic Document.Provenance getProvenance()
The history of this annotation.
.google.cloud.documentai.v1beta2.Document.Provenance provenance = 8;getProvenance in interface Document.Page.FormFieldOrBuilderpublic Document.ProvenanceOrBuilder getProvenanceOrBuilder()
The history of this annotation.
.google.cloud.documentai.v1beta2.Document.Provenance provenance = 8;getProvenanceOrBuilder in interface Document.Page.FormFieldOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Document.Page.FormField parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Page.FormField parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Page.FormField parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Page.FormField parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Page.FormField parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Page.FormField parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Page.FormField parseFrom(InputStream input) throws IOException
IOExceptionpublic static Document.Page.FormField parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Document.Page.FormField parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Document.Page.FormField parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Document.Page.FormField parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Document.Page.FormField parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Document.Page.FormField.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Document.Page.FormField.Builder newBuilder()
public static Document.Page.FormField.Builder newBuilder(Document.Page.FormField prototype)
public Document.Page.FormField.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Document.Page.FormField.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Document.Page.FormField getDefaultInstance()
public static com.google.protobuf.Parser<Document.Page.FormField> parser()
public com.google.protobuf.Parser<Document.Page.FormField> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Document.Page.FormField getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.