com.google.cloud.documentai.v1beta3

Interface Document.Page.FormFieldOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Document.Page.FormField, Document.Page.FormField.Builder

Enclosing class:

Document.Page

public static interface Document.Page.FormFieldOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
Document.Page.Layout	getFieldName() [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] name. e.g.
Document.Page.LayoutOrBuilder	getFieldNameOrBuilder() [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] name. e.g.
Document.Page.Layout	getFieldValue() [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] value.
Document.Page.LayoutOrBuilder	getFieldValueOrBuilder() [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.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.
Document.Provenance	getProvenance() The history of this annotation.
Document.ProvenanceOrBuilder	getProvenanceOrBuilder() The history of this annotation.
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.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] name. e.g.
boolean	hasFieldValue() [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] value.
boolean	hasProvenance() The history of this annotation.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasFieldName

boolean hasFieldName()

 [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
 

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

Returns:

Whether the fieldName field is set.

getFieldName

Document.Page.Layout getFieldName()

 [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
 

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

Returns:

The fieldName.

getFieldNameOrBuilder

Document.Page.LayoutOrBuilder getFieldNameOrBuilder()

 [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
 

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

hasFieldValue

boolean hasFieldValue()

 [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 value.
 

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

Returns:

Whether the fieldValue field is set.

getFieldValue

Document.Page.Layout getFieldValue()

 [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 value.
 

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

Returns:

The fieldValue.

getFieldValueOrBuilder

Document.Page.LayoutOrBuilder getFieldValueOrBuilder()

 [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 value.
 

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

getNameDetectedLanguagesList

List<Document.Page.DetectedLanguage> getNameDetectedLanguagesList()

 A list of detected languages for name together with confidence.
 

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

getNameDetectedLanguages

Document.Page.DetectedLanguage getNameDetectedLanguages(int index)

 A list of detected languages for name together with confidence.
 

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

getNameDetectedLanguagesCount

int getNameDetectedLanguagesCount()

 A list of detected languages for name together with confidence.
 

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

getNameDetectedLanguagesOrBuilderList

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

 A list of detected languages for name together with confidence.
 

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

getNameDetectedLanguagesOrBuilder

Document.Page.DetectedLanguageOrBuilder getNameDetectedLanguagesOrBuilder(int index)

 A list of detected languages for name together with confidence.
 

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

getValueDetectedLanguagesList

List<Document.Page.DetectedLanguage> getValueDetectedLanguagesList()

 A list of detected languages for value together with confidence.
 

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

getValueDetectedLanguages

Document.Page.DetectedLanguage getValueDetectedLanguages(int index)

 A list of detected languages for value together with confidence.
 

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

getValueDetectedLanguagesCount

int getValueDetectedLanguagesCount()

 A list of detected languages for value together with confidence.
 

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

getValueDetectedLanguagesOrBuilderList

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

 A list of detected languages for value together with confidence.
 

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

getValueDetectedLanguagesOrBuilder

Document.Page.DetectedLanguageOrBuilder getValueDetectedLanguagesOrBuilder(int index)

 A list of detected languages for value together with confidence.
 

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

getValueType

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:

The valueType.

getValueTypeBytes

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;

Returns:

The bytes for valueType.

getCorrectedKeyText

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:

The correctedKeyText.

getCorrectedKeyTextBytes

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;

Returns:

The bytes for correctedKeyText.

getCorrectedValueText

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:

The correctedValueText.

getCorrectedValueTextBytes

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;

Returns:

The bytes for correctedValueText.

hasProvenance

boolean hasProvenance()

 The history of this annotation.
 

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

Returns:

Whether the provenance field is set.

getProvenance

Document.Provenance getProvenance()

 The history of this annotation.
 

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

Returns:

The provenance.

getProvenanceOrBuilder

Document.ProvenanceOrBuilder getProvenanceOrBuilder()

 The history of this annotation.
 

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