- 2.80.0 (latest)
- 2.79.0
- 2.78.0
- 2.77.0
- 2.76.0
- 2.74.0
- 2.72.0
- 2.71.0
- 2.68.0
- 2.67.0
- 2.66.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 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 final class Document.Page.FormField.Builder extends GeneratedMessageV3.Builder<Document.Page.FormField.Builder> implements Document.Page.FormFieldOrBuilderA form field detected on the page.
Protobuf type google.cloud.documentai.v1beta3.Document.Page.FormField
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Page.FormField.BuilderImplements
Document.Page.FormFieldOrBuilderStatic 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.v1beta3.Document.Page.DetectedLanguage name_detected_languages = 3;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.DetectedLanguage value_detected_languages = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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 |
|
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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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 |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
This builder for chaining. |
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 |
|
clearFieldName()
public Document.Page.FormField.Builder clearFieldName() Layout for the
FormField
name. e.g. Address, Email, Grand total, Phone number, etc.
.google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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 |
|
clearProvenance()
public Document.Page.FormField.Builder clearProvenance()The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
| Returns | |
|---|---|
| Type | Description |
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.v1beta3.Document.Page.DetectedLanguage value_detected_languages = 4;
| Returns | |
|---|---|
| Type | Description |
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_valueis normal text) unfilled_checkboxfilled_checkbox
string value_type = 5;
| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
This builder for chaining. |
clone()
public Document.Page.FormField.Builder clone()| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for correctedValueText. |
getDefaultInstanceForType()
public Document.Page.FormField getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFieldName()
public Document.Page.Layout getFieldName() Layout for the
FormField
name. e.g. Address, Email, Grand total, Phone number, etc.
.google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.DetectedLanguage name_detected_languages = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.Page.DetectedLanguageOrBuilder> |
|
getProvenance()
public Document.Provenance getProvenance()The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
| Returns | |
|---|---|
| Type | Description |
Document.Provenance |
The provenance. |
getProvenanceBuilder()
public Document.Provenance.Builder getProvenanceBuilder()The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
| Returns | |
|---|---|
| Type | Description |
Document.Provenance.Builder |
|
getProvenanceOrBuilder()
public Document.ProvenanceOrBuilder getProvenanceOrBuilder()The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
| Returns | |
|---|---|
| Type | Description |
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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.DetectedLanguage value_detected_languages = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.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_valueis normal text) unfilled_checkboxfilled_checkbox
string value_type = 5;
| Returns | |
|---|---|
| Type | Description |
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_valueis normal text) unfilled_checkboxfilled_checkbox
string value_type = 5;
| Returns | |
|---|---|
| Type | Description |
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.v1beta3.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.v1beta3.Document.Page.Layout field_value = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fieldValue field is set. |
hasProvenance()
public boolean hasProvenance()The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the provenance field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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.v1beta3.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.v1beta3.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 |
|
| 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 |
|
mergeProvenance(Document.Provenance value)
public Document.Page.FormField.Builder mergeProvenance(Document.Provenance value)The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
Document.Provenance |
| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Page.FormField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
|
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.v1beta3.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.v1beta3.Document.Page.DetectedLanguage value_detected_languages = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe correctedKeyText to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for correctedKeyText to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe correctedValueText to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for correctedValueText to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
|
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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.DetectedLanguage name_detected_languages = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Document.Page.DetectedLanguage.Builder |
| Returns | |
|---|---|
| Type | Description |
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.v1beta3.Document.Provenance provenance = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
Document.Provenance |
| Returns | |
|---|---|
| Type | Description |
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.v1beta3.Document.Provenance provenance = 8;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Document.Provenance.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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Page.FormField.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
|
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.v1beta3.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.v1beta3.Document.Page.DetectedLanguage value_detected_languages = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Document.Page.DetectedLanguage.Builder |
| Returns | |
|---|---|
| Type | Description |
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_valueis normal text) unfilled_checkboxfilled_checkbox
string value_type = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe valueType to set. |
| Returns | |
|---|---|
| Type | Description |
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_valueis normal text) unfilled_checkboxfilled_checkbox
string value_type = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for valueType to set. |
| Returns | |
|---|---|
| Type | Description |
Document.Page.FormField.Builder |
This builder for chaining. |