Class FormExtractionParams.Builder (2.49.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllKeyValuePairHints(Iterable<? extends KeyValuePairHint> values)

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
values Iterable<? extends com.google.cloud.documentai.v1beta2.KeyValuePairHint>
Returns
Type Description
FormExtractionParams.Builder

addKeyValuePairHints(KeyValuePairHint value)

public FormExtractionParams.Builder addKeyValuePairHints(KeyValuePairHint value)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
value KeyValuePairHint
Returns
Type Description
FormExtractionParams.Builder

addKeyValuePairHints(KeyValuePairHint.Builder builderForValue)

public FormExtractionParams.Builder addKeyValuePairHints(KeyValuePairHint.Builder builderForValue)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
builderForValue KeyValuePairHint.Builder
Returns
Type Description
FormExtractionParams.Builder

addKeyValuePairHints(int index, KeyValuePairHint value)

public FormExtractionParams.Builder addKeyValuePairHints(int index, KeyValuePairHint value)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
Name Description
index int
value KeyValuePairHint
Returns
Type Description
FormExtractionParams.Builder

addKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)

public FormExtractionParams.Builder addKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
Name Description
index int
builderForValue KeyValuePairHint.Builder
Returns
Type Description
FormExtractionParams.Builder

addKeyValuePairHintsBuilder()

public KeyValuePairHint.Builder addKeyValuePairHintsBuilder()

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type Description
KeyValuePairHint.Builder

addKeyValuePairHintsBuilder(int index)

public KeyValuePairHint.Builder addKeyValuePairHintsBuilder(int index)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
index int
Returns
Type Description
KeyValuePairHint.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FormExtractionParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FormExtractionParams.Builder
Overrides

build()

public FormExtractionParams build()
Returns
Type Description
FormExtractionParams

buildPartial()

public FormExtractionParams buildPartial()
Returns
Type Description
FormExtractionParams

clear()

public FormExtractionParams.Builder clear()
Returns
Type Description
FormExtractionParams.Builder
Overrides

clearEnabled()

public FormExtractionParams.Builder clearEnabled()

Whether to enable form extraction.

bool enabled = 1;

Returns
Type Description
FormExtractionParams.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FormExtractionParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FormExtractionParams.Builder
Overrides

clearKeyValuePairHints()

public FormExtractionParams.Builder clearKeyValuePairHints()

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type Description
FormExtractionParams.Builder

clearModelVersion()

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;

Returns
Type Description
FormExtractionParams.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FormExtractionParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FormExtractionParams.Builder
Overrides

clone()

public FormExtractionParams.Builder clone()
Returns
Type Description
FormExtractionParams.Builder
Overrides

getDefaultInstanceForType()

public FormExtractionParams getDefaultInstanceForType()
Returns
Type Description
FormExtractionParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnabled()

public boolean getEnabled()

Whether to enable form extraction.

bool enabled = 1;

Returns
Type Description
boolean

The enabled.

getKeyValuePairHints(int index)

public KeyValuePairHint getKeyValuePairHints(int index)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
index int
Returns
Type Description
KeyValuePairHint

getKeyValuePairHintsBuilder(int index)

public KeyValuePairHint.Builder getKeyValuePairHintsBuilder(int index)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
index int
Returns
Type Description
KeyValuePairHint.Builder

getKeyValuePairHintsBuilderList()

public List<KeyValuePairHint.Builder> getKeyValuePairHintsBuilderList()

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type Description
List<Builder>

getKeyValuePairHintsCount()

public int getKeyValuePairHintsCount()

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type Description
int

getKeyValuePairHintsList()

public List<KeyValuePairHint> getKeyValuePairHintsList()

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Returns
Type Description
List<KeyValuePairHint>

getKeyValuePairHintsOrBuilder(int index)

public KeyValuePairHintOrBuilder getKeyValuePairHintsOrBuilder(int index)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
index int
Returns
Type Description
KeyValuePairHintOrBuilder

getKeyValuePairHintsOrBuilderList()

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>

getModelVersion()

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.

getModelVersionBytes()

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FormExtractionParams other)

public FormExtractionParams.Builder mergeFrom(FormExtractionParams other)
Parameter
Name Description
other FormExtractionParams
Returns
Type Description
FormExtractionParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public FormExtractionParams.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FormExtractionParams.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FormExtractionParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FormExtractionParams.Builder
Overrides

removeKeyValuePairHints(int index)

public FormExtractionParams.Builder removeKeyValuePairHints(int index)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameter
Name Description
index int
Returns
Type Description
FormExtractionParams.Builder

setEnabled(boolean value)

public FormExtractionParams.Builder setEnabled(boolean value)

Whether to enable form extraction.

bool enabled = 1;

Parameter
Name Description
value boolean

The enabled to set.

Returns
Type Description
FormExtractionParams.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FormExtractionParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FormExtractionParams.Builder
Overrides

setKeyValuePairHints(int index, KeyValuePairHint value)

public FormExtractionParams.Builder setKeyValuePairHints(int index, KeyValuePairHint value)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
Name Description
index int
value KeyValuePairHint
Returns
Type Description
FormExtractionParams.Builder

setKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)

public FormExtractionParams.Builder setKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue)

Reserved for future use.

repeated .google.cloud.documentai.v1beta2.KeyValuePairHint key_value_pair_hints = 2;

Parameters
Name Description
index int
builderForValue KeyValuePairHint.Builder
Returns
Type Description
FormExtractionParams.Builder

setModelVersion(String value)

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
value String

The modelVersion to set.

Returns
Type Description
FormExtractionParams.Builder

This builder for chaining.

setModelVersionBytes(ByteString value)

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
value ByteString

The bytes for modelVersion to set.

Returns
Type Description
FormExtractionParams.Builder

This builder for chaining.

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

public FormExtractionParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FormExtractionParams.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FormExtractionParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FormExtractionParams.Builder
Overrides