Class EntityExtractionParams (2.15.0) 

public final class EntityExtractionParams extends GeneratedMessageV3 implements EntityExtractionParamsOrBuilder

Parameters to control entity extraction behavior.

Protobuf type google.cloud.documentai.v1beta1.EntityExtractionParams

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EntityExtractionParams

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EntityExtractionParams getDefaultInstance()
Returns
Type Description
EntityExtractionParams

getDescriptor()

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

newBuilder()

public static EntityExtractionParams.Builder newBuilder()
Returns
Type Description
EntityExtractionParams.Builder

newBuilder(EntityExtractionParams prototype)

public static EntityExtractionParams.Builder newBuilder(EntityExtractionParams prototype)
Parameter
Name Description
prototype EntityExtractionParams
Returns
Type Description
EntityExtractionParams.Builder

parseDelimitedFrom(InputStream input)

public static EntityExtractionParams parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EntityExtractionParams parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EntityExtractionParams parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EntityExtractionParams parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EntityExtractionParams parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EntityExtractionParams parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EntityExtractionParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityExtractionParams
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EntityExtractionParams> parser()
Returns
Type Description
Parser<EntityExtractionParams>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public EntityExtractionParams getDefaultInstanceForType()
Returns
Type Description
EntityExtractionParams

getEnabled()

public boolean getEnabled()

Whether to enable entity extraction.

bool enabled = 1;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for modelVersion.

getParserForType()

public Parser<EntityExtractionParams> getParserForType()
Returns
Type Description
Parser<EntityExtractionParams>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EntityExtractionParams.Builder newBuilderForType()
Returns
Type Description
EntityExtractionParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EntityExtractionParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EntityExtractionParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EntityExtractionParams.Builder toBuilder()
Returns
Type Description
EntityExtractionParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException