com.google.cloud.documentai.v1beta2

Class FormExtractionParams.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

com.google.cloud.documentai.v1beta2.FormExtractionParams.Builder

All Implemented Interfaces:

FormExtractionParamsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

FormExtractionParams

public static final class FormExtractionParams.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>
implements FormExtractionParamsOrBuilder

 Parameters to control form extraction behavior.
 

Protobuf type google.cloud.documentai.v1beta2.FormExtractionParams

Method Summary

Modifier and Type	Method and Description
FormExtractionParams.Builder	addAllKeyValuePairHints(Iterable<? extends KeyValuePairHint> values) Reserved for future use.
FormExtractionParams.Builder	addKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue) Reserved for future use.
FormExtractionParams.Builder	addKeyValuePairHints(int index, KeyValuePairHint value) Reserved for future use.
FormExtractionParams.Builder	addKeyValuePairHints(KeyValuePairHint.Builder builderForValue) Reserved for future use.
FormExtractionParams.Builder	addKeyValuePairHints(KeyValuePairHint value) Reserved for future use.
KeyValuePairHint.Builder	addKeyValuePairHintsBuilder() Reserved for future use.
KeyValuePairHint.Builder	addKeyValuePairHintsBuilder(int index) Reserved for future use.
FormExtractionParams.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FormExtractionParams	build()
FormExtractionParams	buildPartial()
FormExtractionParams.Builder	clear()
FormExtractionParams.Builder	clearEnabled() Whether to enable form extraction.
FormExtractionParams.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
FormExtractionParams.Builder	clearKeyValuePairHints() Reserved for future use.
FormExtractionParams.Builder	clearModelVersion() Model version of the form extraction system.
FormExtractionParams.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
FormExtractionParams.Builder	clone()
FormExtractionParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getEnabled() Whether to enable form extraction.
KeyValuePairHint	getKeyValuePairHints(int index) Reserved for future use.
KeyValuePairHint.Builder	getKeyValuePairHintsBuilder(int index) Reserved for future use.
List<KeyValuePairHint.Builder>	getKeyValuePairHintsBuilderList() Reserved for future use.
int	getKeyValuePairHintsCount() Reserved for future use.
List<KeyValuePairHint>	getKeyValuePairHintsList() Reserved for future use.
KeyValuePairHintOrBuilder	getKeyValuePairHintsOrBuilder(int index) Reserved for future use.
List<? extends KeyValuePairHintOrBuilder>	getKeyValuePairHintsOrBuilderList() Reserved for future use.
String	getModelVersion() Model version of the form extraction system.
com.google.protobuf.ByteString	getModelVersionBytes() Model version of the form extraction system.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FormExtractionParams.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FormExtractionParams.Builder	mergeFrom(FormExtractionParams other)
FormExtractionParams.Builder	mergeFrom(com.google.protobuf.Message other)
FormExtractionParams.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FormExtractionParams.Builder	removeKeyValuePairHints(int index) Reserved for future use.
FormExtractionParams.Builder	setEnabled(boolean value) Whether to enable form extraction.
FormExtractionParams.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FormExtractionParams.Builder	setKeyValuePairHints(int index, KeyValuePairHint.Builder builderForValue) Reserved for future use.
FormExtractionParams.Builder	setKeyValuePairHints(int index, KeyValuePairHint value) Reserved for future use.
FormExtractionParams.Builder	setModelVersion(String value) Model version of the form extraction system.
FormExtractionParams.Builder	setModelVersionBytes(com.google.protobuf.ByteString value) Model version of the form extraction system.
FormExtractionParams.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
FormExtractionParams.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

clear

public FormExtractionParams.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

getDefaultInstanceForType

public FormExtractionParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FormExtractionParams build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FormExtractionParams buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public FormExtractionParams.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

setField

public FormExtractionParams.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

clearField

public FormExtractionParams.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

clearOneof

public FormExtractionParams.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

setRepeatedField

public FormExtractionParams.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

addRepeatedField

public FormExtractionParams.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

mergeFrom

public FormExtractionParams.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FormExtractionParams.Builder>

mergeFrom

public FormExtractionParams.Builder mergeFrom(FormExtractionParams other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

mergeFrom

public FormExtractionParams.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FormExtractionParams.Builder>

Throws:

IOException

getEnabled

public boolean getEnabled()

 Whether to enable form extraction.
 

bool enabled = 1;

Specified by:

getEnabled in interface FormExtractionParamsOrBuilder

Returns:

The enabled.

setEnabled

public FormExtractionParams.Builder setEnabled(boolean value)

 Whether to enable form extraction.
 

bool enabled = 1;

Parameters:

value - The enabled to set.

Returns:

This builder for chaining.

clearEnabled

public FormExtractionParams.Builder clearEnabled()

 Whether to enable form extraction.
 

bool enabled = 1;

Returns:

This builder for chaining.

getKeyValuePairHintsList

public List<KeyValuePairHint> getKeyValuePairHintsList()

 Reserved for future use.
 

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

Specified by:

getKeyValuePairHintsList in interface FormExtractionParamsOrBuilder

getKeyValuePairHintsCount

public int getKeyValuePairHintsCount()

 Reserved for future use.
 

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

Specified by:

getKeyValuePairHintsCount in interface FormExtractionParamsOrBuilder

getKeyValuePairHints

public KeyValuePairHint getKeyValuePairHints(int index)

 Reserved for future use.
 

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

Specified by:

getKeyValuePairHints in interface FormExtractionParamsOrBuilder

setKeyValuePairHints

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

 Reserved for future use.
 

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

setKeyValuePairHints

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

 Reserved for future use.
 

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

addKeyValuePairHints

public FormExtractionParams.Builder addKeyValuePairHints(KeyValuePairHint value)

 Reserved for future use.
 

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

addKeyValuePairHints

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

 Reserved for future use.
 

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

addKeyValuePairHints

public FormExtractionParams.Builder addKeyValuePairHints(KeyValuePairHint.Builder builderForValue)

 Reserved for future use.
 

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

addKeyValuePairHints

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

 Reserved for future use.
 

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

addAllKeyValuePairHints

public FormExtractionParams.Builder addAllKeyValuePairHints(Iterable<? extends KeyValuePairHint> values)

 Reserved for future use.
 

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

clearKeyValuePairHints

public FormExtractionParams.Builder clearKeyValuePairHints()

 Reserved for future use.
 

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

removeKeyValuePairHints

public FormExtractionParams.Builder removeKeyValuePairHints(int index)

 Reserved for future use.
 

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

getKeyValuePairHintsBuilder

public KeyValuePairHint.Builder getKeyValuePairHintsBuilder(int index)

 Reserved for future use.
 

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

getKeyValuePairHintsOrBuilder

public KeyValuePairHintOrBuilder getKeyValuePairHintsOrBuilder(int index)

 Reserved for future use.
 

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

Specified by:

getKeyValuePairHintsOrBuilder in interface FormExtractionParamsOrBuilder

getKeyValuePairHintsOrBuilderList

public List<? extends KeyValuePairHintOrBuilder> getKeyValuePairHintsOrBuilderList()

 Reserved for future use.
 

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

Specified by:

getKeyValuePairHintsOrBuilderList in interface FormExtractionParamsOrBuilder

addKeyValuePairHintsBuilder

public KeyValuePairHint.Builder addKeyValuePairHintsBuilder()

 Reserved for future use.
 

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

addKeyValuePairHintsBuilder

public KeyValuePairHint.Builder addKeyValuePairHintsBuilder(int index)

 Reserved for future use.
 

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

getKeyValuePairHintsBuilderList

public List<KeyValuePairHint.Builder> getKeyValuePairHintsBuilderList()

 Reserved for future use.
 

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

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;

Specified by:

getModelVersion in interface FormExtractionParamsOrBuilder

Returns:

The modelVersion.

getModelVersionBytes

public com.google.protobuf.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;

Specified by:

getModelVersionBytes in interface FormExtractionParamsOrBuilder

Returns:

The bytes for modelVersion.

setModelVersion

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;

Parameters:

value - The modelVersion to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setModelVersionBytes

public FormExtractionParams.Builder setModelVersionBytes(com.google.protobuf.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;

Parameters:

value - The bytes for modelVersion to set.

Returns:

This builder for chaining.

setUnknownFields

public final FormExtractionParams.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>

mergeUnknownFields

public final FormExtractionParams.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FormExtractionParams.Builder>