Class Document.Page.FormField.Builder (2.53.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.v1beta1.Document.Page.FormField

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage>
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage>
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter
Name Description
value Document.Page.DetectedLanguage
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter
Name Description
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameters
Name Description
index int
value Document.Page.DetectedLanguage
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameters
Name Description
index int
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

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

Parameter
Name Description
index int
Returns
Type Description
Document.Page.DetectedLanguage.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.FormField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name Description
value Document.Page.DetectedLanguage
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name Description
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameters
Name Description
index int
value Document.Page.DetectedLanguage
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameters
Name Description
index int
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

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

Parameter
Name Description
index int
Returns
Type Description
Document.Page.DetectedLanguage.Builder

build()

public Document.Page.FormField build()
Returns
Type Description
Document.Page.FormField

buildPartial()

public Document.Page.FormField buildPartial()
Returns
Type Description
Document.Page.FormField

clear()

public Document.Page.FormField.Builder clear()
Returns
Type Description
Document.Page.FormField.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Document.Page.FormField.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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.v1beta1.Document.Page.Layout field_name = 1;

Returns
Type Description
Document.Page.FormField.Builder

clearFieldValue()

public Document.Page.FormField.Builder clearFieldValue()

Layout for the FormField value.

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

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

Returns
Type Description
Document.Page.FormField.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Page.FormField.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Page.FormField.Builder
Overrides

clearValueDetectedLanguages()

public Document.Page.FormField.Builder clearValueDetectedLanguages()

A list of detected languages for value together with confidence.

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

Returns
Type Description
Document.Page.FormField.Builder

clone()

public Document.Page.FormField.Builder clone()
Returns
Type Description
Document.Page.FormField.Builder
Overrides

getDefaultInstanceForType()

public Document.Page.FormField getDefaultInstanceForType()
Returns
Type Description
Document.Page.FormField

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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.v1beta1.Document.Page.Layout field_name = 1;

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

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

Returns
Type Description
Document.Page.LayoutOrBuilder

getFieldValue()

public Document.Page.Layout getFieldValue()

Layout for the FormField value.

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

Returns
Type Description
Document.Page.Layout

The fieldValue.

getFieldValueBuilder()

public Document.Page.Layout.Builder getFieldValueBuilder()

Layout for the FormField value.

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

Returns
Type Description
Document.Page.Layout.Builder

getFieldValueOrBuilder()

public Document.Page.LayoutOrBuilder getFieldValueOrBuilder()

Layout for the FormField value.

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

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

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Returns
Type Description
List<Builder>

getNameDetectedLanguagesCount()

public int getNameDetectedLanguagesCount()

A list of detected languages for name together with confidence.

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

Returns
Type Description
int

getNameDetectedLanguagesList()

public List<Document.Page.DetectedLanguage> getNameDetectedLanguagesList()

A list of detected languages for name together with confidence.

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

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

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

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

getValueDetectedLanguages(int index)

public Document.Page.DetectedLanguage getValueDetectedLanguages(int index)

A list of detected languages for value together with confidence.

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

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Returns
Type Description
List<Builder>

getValueDetectedLanguagesCount()

public int getValueDetectedLanguagesCount()

A list of detected languages for value together with confidence.

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

Returns
Type Description
int

getValueDetectedLanguagesList()

public List<Document.Page.DetectedLanguage> getValueDetectedLanguagesList()

A list of detected languages for value together with confidence.

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

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

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

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

hasFieldName()

public boolean hasFieldName()

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

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

Returns
Type Description
boolean

Whether the fieldName field is set.

hasFieldValue()

public boolean hasFieldValue()

Layout for the FormField value.

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

Returns
Type Description
boolean

Whether the fieldValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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.v1beta1.Document.Page.Layout field_name = 1;

Parameter
Name Description
value Document.Page.Layout
Returns
Type Description
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.v1beta1.Document.Page.Layout field_value = 2;

Parameter
Name Description
value Document.Page.Layout
Returns
Type Description
Document.Page.FormField.Builder

mergeFrom(Document.Page.FormField other)

public Document.Page.FormField.Builder mergeFrom(Document.Page.FormField other)
Parameter
Name Description
other Document.Page.FormField
Returns
Type Description
Document.Page.FormField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Page.FormField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.FormField.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Page.FormField.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Page.FormField.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.FormField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameter
Name Description
index int
Returns
Type Description
Document.Page.FormField.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.FormField.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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.v1beta1.Document.Page.Layout field_name = 1;

Parameter
Name Description
value Document.Page.Layout
Returns
Type Description
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.v1beta1.Document.Page.Layout field_name = 1;

Parameter
Name Description
builderForValue Document.Page.Layout.Builder
Returns
Type Description
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.v1beta1.Document.Page.Layout field_value = 2;

Parameter
Name Description
value Document.Page.Layout
Returns
Type Description
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.v1beta1.Document.Page.Layout field_value = 2;

Parameter
Name Description
builderForValue Document.Page.Layout.Builder
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameters
Name Description
index int
value Document.Page.DetectedLanguage
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage name_detected_languages = 3;

Parameters
Name Description
index int
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Document.Page.FormField.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.FormField.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameters
Name Description
index int
value Document.Page.DetectedLanguage
Returns
Type Description
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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Parameters
Name Description
index int
builderForValue Document.Page.DetectedLanguage.Builder
Returns
Type Description
Document.Page.FormField.Builder