Class Document.Page.FormField.Builder (2.8.0)

public static final class Document.Page.FormField.Builder extends GeneratedMessageV3.Builder<Document.Page.FormField.Builder> implements Document.Page.FormFieldOrBuilder

A form field detected on the page.

Protobuf type google.cloud.documentai.v1.Document.Page.FormField

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllNameDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

public Document.Page.FormField.Builder addAllNameDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

A list of detected languages for name together with confidence.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguage>
Returns
TypeDescription
Document.Page.FormField.Builder

addAllValueDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

public Document.Page.FormField.Builder addAllValueDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

A list of detected languages for value together with confidence.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguage>
Returns
TypeDescription
Document.Page.FormField.Builder

addNameDetectedLanguages(Document.Page.DetectedLanguage value)

public Document.Page.FormField.Builder addNameDetectedLanguages(Document.Page.DetectedLanguage value)

A list of detected languages for name together with confidence.

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

Parameter
NameDescription
valueDocument.Page.DetectedLanguage
Returns
TypeDescription
Document.Page.FormField.Builder

addNameDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.FormField.Builder addNameDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages for name together with confidence.

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

Parameter
NameDescription
builderForValueDocument.Page.DetectedLanguage.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

addNameDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.FormField.Builder addNameDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages for name together with confidence.

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

Parameters
NameDescription
indexint
valueDocument.Page.DetectedLanguage
Returns
TypeDescription
Document.Page.FormField.Builder

addNameDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.FormField.Builder addNameDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages for name together with confidence.

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

Parameters
NameDescription
indexint
builderForValueDocument.Page.DetectedLanguage.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

addNameDetectedLanguagesBuilder()

public Document.Page.DetectedLanguage.Builder addNameDetectedLanguagesBuilder()

A list of detected languages for name together with confidence.

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

Returns
TypeDescription
Document.Page.DetectedLanguage.Builder

addNameDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder addNameDetectedLanguagesBuilder(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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.FormField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

addValueDetectedLanguages(Document.Page.DetectedLanguage value)

public Document.Page.FormField.Builder addValueDetectedLanguages(Document.Page.DetectedLanguage value)

A list of detected languages for value together with confidence.

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

Parameter
NameDescription
valueDocument.Page.DetectedLanguage
Returns
TypeDescription
Document.Page.FormField.Builder

addValueDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.FormField.Builder addValueDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages for value together with confidence.

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

Parameter
NameDescription
builderForValueDocument.Page.DetectedLanguage.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

addValueDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.FormField.Builder addValueDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages for value together with confidence.

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

Parameters
NameDescription
indexint
valueDocument.Page.DetectedLanguage
Returns
TypeDescription
Document.Page.FormField.Builder

addValueDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.FormField.Builder addValueDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages for value together with confidence.

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

Parameters
NameDescription
indexint
builderForValueDocument.Page.DetectedLanguage.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

addValueDetectedLanguagesBuilder()

public Document.Page.DetectedLanguage.Builder addValueDetectedLanguagesBuilder()

A list of detected languages for value together with confidence.

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

Returns
TypeDescription
Document.Page.DetectedLanguage.Builder

addValueDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder addValueDetectedLanguagesBuilder(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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage.Builder

build()

public Document.Page.FormField build()
Returns
TypeDescription
Document.Page.FormField

buildPartial()

public Document.Page.FormField buildPartial()
Returns
TypeDescription
Document.Page.FormField

clear()

public Document.Page.FormField.Builder clear()
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

clearCorrectedKeyText()

public Document.Page.FormField.Builder clearCorrectedKeyText()

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
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

clearCorrectedValueText()

public Document.Page.FormField.Builder clearCorrectedValueText()

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
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Page.FormField.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

clearFieldName()

public Document.Page.FormField.Builder clearFieldName()

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
TypeDescription
Document.Page.FormField.Builder

clearFieldValue()

public Document.Page.FormField.Builder clearFieldValue()

Layout for the FormField value.

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

Returns
TypeDescription
Document.Page.FormField.Builder

clearNameDetectedLanguages()

public Document.Page.FormField.Builder clearNameDetectedLanguages()

A list of detected languages for name together with confidence.

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

Returns
TypeDescription
Document.Page.FormField.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Page.FormField.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

clearProvenance()

public Document.Page.FormField.Builder clearProvenance()

The history of this annotation.

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

Returns
TypeDescription
Document.Page.FormField.Builder

clearValueDetectedLanguages()

public Document.Page.FormField.Builder clearValueDetectedLanguages()

A list of detected languages for value together with confidence.

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

Returns
TypeDescription
Document.Page.FormField.Builder

clearValueType()

public Document.Page.FormField.Builder clearValueType()

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
Document.Page.FormField.Builder

This builder for chaining.

clone()

public Document.Page.FormField.Builder clone()
Returns
TypeDescription
Document.Page.FormField.Builder
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for correctedValueText.

getDefaultInstanceForType()

public Document.Page.FormField getDefaultInstanceForType()
Returns
TypeDescription
Document.Page.FormField

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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;

Returns
TypeDescription
Document.Page.Layout

The fieldName.

getFieldNameBuilder()

public Document.Page.Layout.Builder getFieldNameBuilder()

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
TypeDescription
Document.Page.Layout.Builder

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;

Returns
TypeDescription
Document.Page.LayoutOrBuilder

getFieldValue()

public Document.Page.Layout getFieldValue()

Layout for the FormField value.

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

Returns
TypeDescription
Document.Page.Layout

The fieldValue.

getFieldValueBuilder()

public Document.Page.Layout.Builder getFieldValueBuilder()

Layout for the FormField value.

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

Returns
TypeDescription
Document.Page.Layout.Builder

getFieldValueOrBuilder()

public Document.Page.LayoutOrBuilder getFieldValueOrBuilder()

Layout for the FormField value.

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

Returns
TypeDescription
Document.Page.LayoutOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage

getNameDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder getNameDetectedLanguagesBuilder(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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage.Builder

getNameDetectedLanguagesBuilderList()

public List<Document.Page.DetectedLanguage.Builder> getNameDetectedLanguagesBuilderList()

A list of detected languages for name together with confidence.

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

Returns
TypeDescription
List<Builder>

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
TypeDescription
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;

Returns
TypeDescription
List<DetectedLanguage>

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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguageOrBuilder

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
TypeDescription
List<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguageOrBuilder>

getProvenance()

public Document.Provenance getProvenance()

The history of this annotation.

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

Returns
TypeDescription
Document.Provenance

The provenance.

getProvenanceBuilder()

public Document.Provenance.Builder getProvenanceBuilder()

The history of this annotation.

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

Returns
TypeDescription
Document.Provenance.Builder

getProvenanceOrBuilder()

public Document.ProvenanceOrBuilder getProvenanceOrBuilder()

The history of this annotation.

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

Returns
TypeDescription
Document.ProvenanceOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage

getValueDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder getValueDetectedLanguagesBuilder(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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage.Builder

getValueDetectedLanguagesBuilderList()

public List<Document.Page.DetectedLanguage.Builder> getValueDetectedLanguagesBuilderList()

A list of detected languages for value together with confidence.

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

Returns
TypeDescription
List<Builder>

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
TypeDescription
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;

Returns
TypeDescription
List<DetectedLanguage>

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
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguageOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the provenance field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFieldName(Document.Page.Layout value)

public Document.Page.FormField.Builder mergeFieldName(Document.Page.Layout value)

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

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

Parameter
NameDescription
valueDocument.Page.Layout
Returns
TypeDescription
Document.Page.FormField.Builder

mergeFieldValue(Document.Page.Layout value)

public Document.Page.FormField.Builder mergeFieldValue(Document.Page.Layout value)

Layout for the FormField value.

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

Parameter
NameDescription
valueDocument.Page.Layout
Returns
TypeDescription
Document.Page.FormField.Builder

mergeFrom(Document.Page.FormField other)

public Document.Page.FormField.Builder mergeFrom(Document.Page.FormField other)
Parameter
NameDescription
otherDocument.Page.FormField
Returns
TypeDescription
Document.Page.FormField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Page.FormField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Document.Page.FormField.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

mergeProvenance(Document.Provenance value)

public Document.Page.FormField.Builder mergeProvenance(Document.Provenance value)

The history of this annotation.

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

Parameter
NameDescription
valueDocument.Provenance
Returns
TypeDescription
Document.Page.FormField.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.FormField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

removeNameDetectedLanguages(int index)

public Document.Page.FormField.Builder removeNameDetectedLanguages(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
NameDescription
indexint
Returns
TypeDescription
Document.Page.FormField.Builder

removeValueDetectedLanguages(int index)

public Document.Page.FormField.Builder removeValueDetectedLanguages(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
NameDescription
indexint
Returns
TypeDescription
Document.Page.FormField.Builder

setCorrectedKeyText(String value)

public Document.Page.FormField.Builder setCorrectedKeyText(String value)

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;

Parameter
NameDescription
valueString

The correctedKeyText to set.

Returns
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

setCorrectedKeyTextBytes(ByteString value)

public Document.Page.FormField.Builder setCorrectedKeyTextBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for correctedKeyText to set.

Returns
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

setCorrectedValueText(String value)

public Document.Page.FormField.Builder setCorrectedValueText(String value)

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;

Parameter
NameDescription
valueString

The correctedValueText to set.

Returns
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

setCorrectedValueTextBytes(ByteString value)

public Document.Page.FormField.Builder setCorrectedValueTextBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for correctedValueText to set.

Returns
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.FormField.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

setFieldName(Document.Page.Layout value)

public Document.Page.FormField.Builder setFieldName(Document.Page.Layout value)

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

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

Parameter
NameDescription
valueDocument.Page.Layout
Returns
TypeDescription
Document.Page.FormField.Builder

setFieldName(Document.Page.Layout.Builder builderForValue)

public Document.Page.FormField.Builder setFieldName(Document.Page.Layout.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueDocument.Page.Layout.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

setFieldValue(Document.Page.Layout value)

public Document.Page.FormField.Builder setFieldValue(Document.Page.Layout value)

Layout for the FormField value.

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

Parameter
NameDescription
valueDocument.Page.Layout
Returns
TypeDescription
Document.Page.FormField.Builder

setFieldValue(Document.Page.Layout.Builder builderForValue)

public Document.Page.FormField.Builder setFieldValue(Document.Page.Layout.Builder builderForValue)

Layout for the FormField value.

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

Parameter
NameDescription
builderForValueDocument.Page.Layout.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

setNameDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.FormField.Builder setNameDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages for name together with confidence.

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

Parameters
NameDescription
indexint
valueDocument.Page.DetectedLanguage
Returns
TypeDescription
Document.Page.FormField.Builder

setNameDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.FormField.Builder setNameDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages for name together with confidence.

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

Parameters
NameDescription
indexint
builderForValueDocument.Page.DetectedLanguage.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

setProvenance(Document.Provenance value)

public Document.Page.FormField.Builder setProvenance(Document.Provenance value)

The history of this annotation.

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

Parameter
NameDescription
valueDocument.Provenance
Returns
TypeDescription
Document.Page.FormField.Builder

setProvenance(Document.Provenance.Builder builderForValue)

public Document.Page.FormField.Builder setProvenance(Document.Provenance.Builder builderForValue)

The history of this annotation.

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

Parameter
NameDescription
builderForValueDocument.Provenance.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Page.FormField.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.FormField.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Page.FormField.Builder
Overrides

setValueDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.FormField.Builder setValueDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages for value together with confidence.

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

Parameters
NameDescription
indexint
valueDocument.Page.DetectedLanguage
Returns
TypeDescription
Document.Page.FormField.Builder

setValueDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.FormField.Builder setValueDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages for value together with confidence.

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

Parameters
NameDescription
indexint
builderForValueDocument.Page.DetectedLanguage.Builder
Returns
TypeDescription
Document.Page.FormField.Builder

setValueType(String value)

public Document.Page.FormField.Builder setValueType(String value)

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;

Parameter
NameDescription
valueString

The valueType to set.

Returns
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.

setValueTypeBytes(ByteString value)

public Document.Page.FormField.Builder setValueTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for valueType to set.

Returns
TypeDescription
Document.Page.FormField.Builder

This builder for chaining.