Interface Document.Page.FormFieldOrBuilder (2.11.0)

public static interface Document.Page.FormFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCorrectedKeyText()

public abstract String getCorrectedKeyText()

An internal field, created for Labeling UI to export key text.

string corrected_key_text = 6;

Returns
TypeDescription
String

The correctedKeyText.

getCorrectedKeyTextBytes()

public abstract ByteString getCorrectedKeyTextBytes()

An internal field, created for Labeling UI to export key text.

string corrected_key_text = 6;

Returns
TypeDescription
ByteString

The bytes for correctedKeyText.

getCorrectedValueText()

public abstract String getCorrectedValueText()

An internal field, created for Labeling UI to export value text.

string corrected_value_text = 7;

Returns
TypeDescription
String

The correctedValueText.

getCorrectedValueTextBytes()

public abstract ByteString getCorrectedValueTextBytes()

An internal field, created for Labeling UI to export value text.

string corrected_value_text = 7;

Returns
TypeDescription
ByteString

The bytes for correctedValueText.

getFieldName()

public abstract Document.Page.Layout getFieldName()

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

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

Returns
TypeDescription
Document.Page.Layout

The fieldName.

getFieldNameOrBuilder()

public abstract Document.Page.LayoutOrBuilder getFieldNameOrBuilder()

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

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

Returns
TypeDescription
Document.Page.LayoutOrBuilder

getFieldValue()

public abstract Document.Page.Layout getFieldValue()

Layout for the FormField value.

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

Returns
TypeDescription
Document.Page.Layout

The fieldValue.

getFieldValueOrBuilder()

public abstract Document.Page.LayoutOrBuilder getFieldValueOrBuilder()

Layout for the FormField value.

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

Returns
TypeDescription
Document.Page.LayoutOrBuilder

getNameDetectedLanguages(int index)

public abstract 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage

getNameDetectedLanguagesCount()

public abstract int getNameDetectedLanguagesCount()

A list of detected languages for name together with confidence.

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

Returns
TypeDescription
int

getNameDetectedLanguagesList()

public abstract 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;

Returns
TypeDescription
List<DetectedLanguage>

getNameDetectedLanguagesOrBuilder(int index)

public abstract 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguageOrBuilder

getNameDetectedLanguagesOrBuilderList()

public abstract 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;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta2.Document.Page.DetectedLanguageOrBuilder>

getValueDetectedLanguages(int index)

public abstract 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage

getValueDetectedLanguagesCount()

public abstract int getValueDetectedLanguagesCount()

A list of detected languages for value together with confidence.

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

Returns
TypeDescription
int

getValueDetectedLanguagesList()

public abstract 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;

Returns
TypeDescription
List<DetectedLanguage>

getValueDetectedLanguagesOrBuilder(int index)

public abstract 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguageOrBuilder

getValueDetectedLanguagesOrBuilderList()

public abstract 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;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta2.Document.Page.DetectedLanguageOrBuilder>

getValueType()

public abstract 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
TypeDescription
String

The valueType.

getValueTypeBytes()

public abstract 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
TypeDescription
ByteString

The bytes for valueType.

hasFieldName()

public abstract boolean hasFieldName()

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

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

Returns
TypeDescription
boolean

Whether the fieldName field is set.

hasFieldValue()

public abstract boolean hasFieldValue()

Layout for the FormField value.

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

Returns
TypeDescription
boolean

Whether the fieldValue field is set.