Class TableExtractionParams

  • All Implemented Interfaces:
    TableExtractionParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class TableExtractionParams
    extends com.google.protobuf.GeneratedMessageV3
    implements TableExtractionParamsOrBuilder
     Parameters to control table extraction behavior.
     
    Protobuf type google.cloud.documentai.v1beta1.TableExtractionParams
    See Also:
    Serialized Form
    • Field Detail

      • TABLE_BOUND_HINTS_FIELD_NUMBER

        public static final int TABLE_BOUND_HINTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • HEADER_HINTS_FIELD_NUMBER

        public static final int HEADER_HINTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MODEL_VERSION_FIELD_NUMBER

        public static final int MODEL_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • 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
      • 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];
        Specified by:
        getTableBoundHintsList in interface TableExtractionParamsOrBuilder
      • 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];
        Specified by:
        getTableBoundHintsOrBuilderList in interface TableExtractionParamsOrBuilder
      • 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];
        Specified by:
        getTableBoundHintsCount in interface TableExtractionParamsOrBuilder
      • getTableBoundHints

        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];
        Specified by:
        getTableBoundHints in interface TableExtractionParamsOrBuilder
      • getTableBoundHintsOrBuilder

        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];
        Specified by:
        getTableBoundHintsOrBuilder in interface TableExtractionParamsOrBuilder
      • getHeaderHintsList

        public com.google.protobuf.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];
        Specified by:
        getHeaderHintsList in interface TableExtractionParamsOrBuilder
        Returns:
        A list containing the headerHints.
      • 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];
        Specified by:
        getHeaderHintsCount in interface TableExtractionParamsOrBuilder
        Returns:
        The count of headerHints.
      • getHeaderHints

        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];
        Specified by:
        getHeaderHints in interface TableExtractionParamsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The headerHints at the given index.
      • getHeaderHintsBytes

        public com.google.protobuf.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];
        Specified by:
        getHeaderHintsBytes in interface TableExtractionParamsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the headerHints at the given index.
      • 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;
        Specified by:
        getModelVersion in interface TableExtractionParamsOrBuilder
        Returns:
        The modelVersion.
      • getModelVersionBytes

        public com.google.protobuf.ByteString getModelVersionBytes()
         Model version of the table extraction system. Default is "builtin/stable".
         Specify "builtin/latest" for the latest model.
         
        string model_version = 4;
        Specified by:
        getModelVersionBytes in interface TableExtractionParamsOrBuilder
        Returns:
        The bytes for modelVersion.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static TableExtractionParams parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TableExtractionParams parseFrom​(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TableExtractionParams parseFrom​(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TableExtractionParams parseFrom​(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TableExtractionParams parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TableExtractionParams parseFrom​(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public TableExtractionParams.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public TableExtractionParams.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected TableExtractionParams.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<TableExtractionParams> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public TableExtractionParams getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder