Class FormExtractionParams.Builder (2.26.0)
2.91.0 (latest)
2.89.0
2.87.0
2.86.0
2.85.0
2.84.0
2.82.0
2.80.0
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 FormExtractionParams . Builder extends GeneratedMessageV3 . Builder<FormExtractionParams . Builder > implements FormExtractionParamsOrBuilder
Parameters to control form extraction behavior.
Protobuf type google.cloud.documentai.v1beta2.FormExtractionParams
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors . Descriptor getDescriptor ()
Methods
public FormExtractionParams . Builder addAllKeyValuePairHints ( Iterable <? extends KeyValuePairHint > values )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
valuesIterable <? extends com.google.cloud.documentai.v1beta2.KeyValuePairHint >
public FormExtractionParams . Builder addKeyValuePairHints ( KeyValuePairHint value )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public FormExtractionParams . Builder addKeyValuePairHints ( KeyValuePairHint . Builder builderForValue )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public FormExtractionParams . Builder addKeyValuePairHints ( int index , KeyValuePairHint value )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public FormExtractionParams . Builder addKeyValuePairHints ( int index , KeyValuePairHint . Builder builderForValue )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public KeyValuePairHint . Builder addKeyValuePairHintsBuilder ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public KeyValuePairHint . Builder addKeyValuePairHintsBuilder ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public FormExtractionParams . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
public FormExtractionParams build ()
public FormExtractionParams buildPartial ()
public FormExtractionParams . Builder clear ()
Overrides
public FormExtractionParams . Builder clearEnabled ()
Whether to enable form extraction.
bool enabled = 1;
public FormExtractionParams . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
public FormExtractionParams . Builder clearKeyValuePairHints ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public FormExtractionParams . Builder clearModelVersion ()
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: "custom/{model_name}". Model name
format is "bucket_name/path/to/modeldir" corresponding to
"gs://bucket_name/path/to/modeldir" where annotated examples are stored.
string model_version = 3;
public FormExtractionParams . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
public FormExtractionParams . Builder clone ()
Overrides
public FormExtractionParams getDefaultInstanceForType ()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
public boolean getEnabled ()
Whether to enable form extraction.
bool enabled = 1;
Returns
Type Description
boolean The enabled.
public KeyValuePairHint getKeyValuePairHints ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public KeyValuePairHint . Builder getKeyValuePairHintsBuilder ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public List<KeyValuePairHint . Builder > getKeyValuePairHintsBuilderList ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public int getKeyValuePairHintsCount ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Returns
Type Description
int
public List<KeyValuePairHint> getKeyValuePairHintsList ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public KeyValuePairHintOrBuilder getKeyValuePairHintsOrBuilder ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public List <? extends KeyValuePairHintOrBuilder > getKeyValuePairHintsOrBuilderList ()
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Returns
Type Description
List <? extends com.google.cloud.documentai.v1beta2.KeyValuePairHintOrBuilder >
public String getModelVersion ()
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: "custom/{model_name}". Model name
format is "bucket_name/path/to/modeldir" corresponding to
"gs://bucket_name/path/to/modeldir" where annotated examples are stored.
string model_version = 3;
Returns
Type Description
String The modelVersion.
public ByteString getModelVersionBytes ()
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: "custom/{model_name}". Model name
format is "bucket_name/path/to/modeldir" corresponding to
"gs://bucket_name/path/to/modeldir" where annotated examples are stored.
string model_version = 3;
Returns
Type Description
ByteString The bytes for modelVersion.
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public FormExtractionParams . Builder mergeFrom ( FormExtractionParams other )
public FormExtractionParams . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
public FormExtractionParams . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
public final FormExtractionParams . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
public FormExtractionParams . Builder removeKeyValuePairHints ( int index )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
Parameter
Name Description
indexint
public FormExtractionParams . Builder setEnabled ( boolean value )
Whether to enable form extraction.
bool enabled = 1;
Parameter
Name Description
valueboolean The enabled to set.
public FormExtractionParams . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
public FormExtractionParams . Builder setKeyValuePairHints ( int index , KeyValuePairHint value )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public FormExtractionParams . Builder setKeyValuePairHints ( int index , KeyValuePairHint . Builder builderForValue )
Reserved for future use.
repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;
public FormExtractionParams . Builder setModelVersion ( String value )
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: "custom/{model_name}". Model name
format is "bucket_name/path/to/modeldir" corresponding to
"gs://bucket_name/path/to/modeldir" where annotated examples are stored.
string model_version = 3;
Parameter
Name Description
valueString The modelVersion to set.
public FormExtractionParams . Builder setModelVersionBytes ( ByteString value )
Model version of the form extraction system. Default is
"builtin/stable". Specify "builtin/latest" for the latest model.
For custom form models, specify: "custom/{model_name}". Model name
format is "bucket_name/path/to/modeldir" corresponding to
"gs://bucket_name/path/to/modeldir" where annotated examples are stored.
string model_version = 3;
Parameter
Name Description
valueByteString The bytes for modelVersion to set.
public FormExtractionParams . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
public final FormExtractionParams . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
