Class TableExtractionParams (2.31.0)

public final class TableExtractionParams extends GeneratedMessageV3 implements TableExtractionParamsOrBuilder

Parameters to control table extraction behavior.

Protobuf type google.cloud.documentai.v1beta1.TableExtractionParams

Static Fields

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

HEADER_HINTS_FIELD_NUMBER

public static final int HEADER_HINTS_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_BOUND_HINTS_FIELD_NUMBER

public static final int TABLE_BOUND_HINTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TableExtractionParams getDefaultInstance()
Returns
TypeDescription
TableExtractionParams

getDescriptor()

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

newBuilder()

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

newBuilder(TableExtractionParams prototype)

public static TableExtractionParams.Builder newBuilder(TableExtractionParams prototype)
Parameter
NameDescription
prototypeTableExtractionParams
Returns
TypeDescription
TableExtractionParams.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public TableExtractionParams getDefaultInstanceForType()
Returns
TypeDescription
TableExtractionParams

getEnabled()

public boolean getEnabled()

Whether to enable table extraction.

bool enabled = 1;

Returns
TypeDescription
boolean

The enabled.

getHeaderHints(int index)

public String getHeaderHints(int index)

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The headerHints at the given index.

getHeaderHintsBytes(int index)

public ByteString getHeaderHintsBytes(int index)

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the headerHints at the given index.

getHeaderHintsCount()

public int getHeaderHintsCount()

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of headerHints.

getHeaderHintsList()

public ProtocolStringList getHeaderHintsList()

Optional. Table header hints. The extraction will bias towards producing these terms as table headers, which may improve accuracy.

repeated string header_hints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the headerHints.

getModelVersion()

public String getModelVersion()

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

string model_version = 4;

Returns
TypeDescription
String

The modelVersion.

getModelVersionBytes()

public ByteString getModelVersionBytes()

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

string model_version = 4;

Returns
TypeDescription
ByteString

The bytes for modelVersion.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTableBoundHints(int index)

public TableBoundHint getTableBoundHints(int index)

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
TableBoundHint

getTableBoundHintsCount()

public int getTableBoundHintsCount()

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getTableBoundHintsList()

public List<TableBoundHint> getTableBoundHintsList()

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<TableBoundHint>

getTableBoundHintsOrBuilder(int index)

public TableBoundHintOrBuilder getTableBoundHintsOrBuilder(int index)

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
TableBoundHintOrBuilder

getTableBoundHintsOrBuilderList()

public List<? extends TableBoundHintOrBuilder> getTableBoundHintsOrBuilderList()

Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.

repeated .google.cloud.documentai.v1beta1.TableBoundHint table_bound_hints = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.TableBoundHintOrBuilder>

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 TableExtractionParams.Builder newBuilderForType()
Returns
TypeDescription
TableExtractionParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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