Interface Document.Page.FormFieldOrBuilder (2.4.3)

Version 2.4.3

• 2.57.0 (latest)
• 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 interface Document.Page.FormFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFieldName()

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

Returns

Type	Description
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.v1.Document.Page.Layout field_name = 1;

Returns

Type	Description
Document.Page.LayoutOrBuilder

getFieldValue()

public abstract Document.Page.Layout getFieldValue()

Layout for the FormField value.

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

Returns

Type	Description
Document.Page.Layout	The fieldValue.

getFieldValueOrBuilder()

public abstract Document.Page.LayoutOrBuilder getFieldValueOrBuilder()

Layout for the FormField value.

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

Returns

Type	Description
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.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.Page.DetectedLanguage

getNameDetectedLanguagesCount()

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

Returns

Type	Description
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.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter

Name	Description
index	int

Returns

Type	Description
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.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

Returns

Type	Description
List<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguageOrBuilder>

getProvenance()

public abstract Document.Provenance getProvenance()

The history of this annotation.

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

Returns

Type	Description
Document.Provenance	The provenance.

getProvenanceOrBuilder()

public abstract Document.ProvenanceOrBuilder getProvenanceOrBuilder()

The history of this annotation.

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

Returns

Type	Description
Document.ProvenanceOrBuilder

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.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter

Name	Description
index	int

Returns

Type	Description
Document.Page.DetectedLanguage

getValueDetectedLanguagesCount()

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

Returns

Type	Description
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.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter

Name	Description
index	int

Returns

Type	Description
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.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

Returns

Type	Description
List<? extends com.google.cloud.documentai.v1.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

Type	Description
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

Type	Description
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.v1.Document.Page.Layout field_name = 1;

Returns

Type	Description
boolean	Whether the fieldName field is set.

hasFieldValue()

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