Class EntityExtractionParams (2.33.0)

public final class EntityExtractionParams extends GeneratedMessageV3 implements EntityExtractionParamsOrBuilder

Parameters to control entity extraction behavior.

Protobuf type google.cloud.documentai.v1beta1.EntityExtractionParams

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EntityExtractionParams getDefaultInstance()
Returns
TypeDescription
EntityExtractionParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EntityExtractionParams.Builder newBuilder()
Returns
TypeDescription
EntityExtractionParams.Builder

newBuilder(EntityExtractionParams prototype)

public static EntityExtractionParams.Builder newBuilder(EntityExtractionParams prototype)
Parameter
NameDescription
prototypeEntityExtractionParams
Returns
TypeDescription
EntityExtractionParams.Builder

parseDelimitedFrom(InputStream input)

public static EntityExtractionParams parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EntityExtractionParams parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EntityExtractionParams parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EntityExtractionParams parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EntityExtractionParams parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EntityExtractionParams parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EntityExtractionParams
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EntityExtractionParams> parser()
Returns
TypeDescription
Parser<EntityExtractionParams>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public EntityExtractionParams getDefaultInstanceForType()
Returns
TypeDescription
EntityExtractionParams

getEnabled()

public boolean getEnabled()

Whether to enable entity extraction.

bool enabled = 1;

Returns
TypeDescription
boolean

The enabled.

getModelVersion()

public String getModelVersion()

Model version of the entity extraction. Default is "builtin/stable". Specify "builtin/latest" for the latest model.

string model_version = 2;

Returns
TypeDescription
String

The modelVersion.

getModelVersionBytes()

public ByteString getModelVersionBytes()

Model version of the entity extraction. Default is "builtin/stable". Specify "builtin/latest" for the latest model.

string model_version = 2;

Returns
TypeDescription
ByteString

The bytes for modelVersion.

getParserForType()

public Parser<EntityExtractionParams> getParserForType()
Returns
TypeDescription
Parser<EntityExtractionParams>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public EntityExtractionParams.Builder newBuilderForType()
Returns
TypeDescription
EntityExtractionParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EntityExtractionParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EntityExtractionParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public EntityExtractionParams.Builder toBuilder()
Returns
TypeDescription
EntityExtractionParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException