Package com.affinda.api.client.models

Class DocumentCollection

  • public final class DocumentCollection
extends Object
    The DocumentCollection model.

    • Constructor Detail

      • DocumentCollection

        public DocumentCollection()

    • Method Detail

      • getIdentifier

        public String getIdentifier()
        Get the identifier property: Uniquely identify a collection.
        Returns:
        the identifier value.

      • setIdentifier

        public DocumentCollection setIdentifier​(String identifier)
        Set the identifier property: Uniquely identify a collection.
        Parameters:
        identifier - the identifier value to set.
        Returns:
        the DocumentCollection object itself.

      • getName

        public String getName()
        Get the name property: The name property.
        Returns:
        the name value.

      • setName

        public DocumentCollection setName​(String name)
        Set the name property: The name property.
        Parameters:
        name - the name value to set.
        Returns:
        the DocumentCollection object itself.

      • getWorkspace

        public DocumentCollectionWorkspace getWorkspace()
        Get the workspace property: The workspace property.
        Returns:
        the workspace value.

      • setWorkspace

        public DocumentCollection setWorkspace​(DocumentCollectionWorkspace workspace)
        Set the workspace property: The workspace property.
        Parameters:
        workspace - the workspace value to set.
        Returns:
        the DocumentCollection object itself.

      • getExtractor

        public Extractor getExtractor()
        Get the extractor property: The extractor property.
        Returns:
        the extractor value.

      • setExtractor

        public DocumentCollection setExtractor​(Extractor extractor)
        Set the extractor property: The extractor property.
        Parameters:
        extractor - the extractor value to set.
        Returns:
        the DocumentCollection object itself.

      • getAutoValidationThreshold

        public Float getAutoValidationThreshold()
        Get the autoValidationThreshold property: The autoValidationThreshold property.
        Returns:
        the autoValidationThreshold value.

      • setAutoValidationThreshold

        public DocumentCollection setAutoValidationThreshold​(Float autoValidationThreshold)
        Set the autoValidationThreshold property: The autoValidationThreshold property.
        Parameters:
        autoValidationThreshold - the autoValidationThreshold value to set.
        Returns:
        the DocumentCollection object itself.

      • getFields

        public List<FieldGroup> getFields()
        Get the fields property: The fields property.
        Returns:
        the fields value.

      • setFields

        public DocumentCollection setFields​(List<FieldGroup> fields)
        Set the fields property: The fields property.
        Parameters:
        fields - the fields value to set.
        Returns:
        the DocumentCollection object itself.

      • getFieldsLayout

        public FieldsLayout getFieldsLayout()
        Get the fieldsLayout property: The fieldsLayout property.
        Returns:
        the fieldsLayout value.

      • setFieldsLayout

        public DocumentCollection setFieldsLayout​(FieldsLayout fieldsLayout)
        Set the fieldsLayout property: The fieldsLayout property.
        Parameters:
        fieldsLayout - the fieldsLayout value to set.
        Returns:
        the DocumentCollection object itself.

      • isFieldsConfigured

        public Boolean isFieldsConfigured()
        Get the fieldsConfigured property: The fieldsConfigured property.
        Returns:
        the fieldsConfigured value.

      • setFieldsConfigured

        public DocumentCollection setFieldsConfigured​(Boolean fieldsConfigured)
        Set the fieldsConfigured property: The fieldsConfigured property.
        Parameters:
        fieldsConfigured - the fieldsConfigured value to set.
        Returns:
        the DocumentCollection object itself.

      • getDateFormatPreference

        public DocumentCollectionDateFormatPreference getDateFormatPreference()
        Get the dateFormatPreference property: The dateFormatPreference property.
        Returns:
        the dateFormatPreference value.

      • setDateFormatPreference

        public DocumentCollection setDateFormatPreference​(DocumentCollectionDateFormatPreference dateFormatPreference)
        Set the dateFormatPreference property: The dateFormatPreference property.
        Parameters:
        dateFormatPreference - the dateFormatPreference value to set.
        Returns:
        the DocumentCollection object itself.

      • isDateFormatFromDocument

        public Boolean isDateFormatFromDocument()
        Get the dateFormatFromDocument property: Predict the date format from any dates in the document that is not ambiguous.
        Returns:
        the dateFormatFromDocument value.

      • setDateFormatFromDocument

        public DocumentCollection setDateFormatFromDocument​(Boolean dateFormatFromDocument)
        Set the dateFormatFromDocument property: Predict the date format from any dates in the document that is not ambiguous.
        Parameters:
        dateFormatFromDocument - the dateFormatFromDocument value to set.
        Returns:
        the DocumentCollection object itself.

      • getExtractorConfig

        public ExtractorConfig getExtractorConfig()
        Get the extractorConfig property: Extra configurations specific to an extractor.
        Returns:
        the extractorConfig value.

      • setExtractorConfig

        public DocumentCollection setExtractorConfig​(ExtractorConfig extractorConfig)
        Set the extractorConfig property: Extra configurations specific to an extractor.
        Parameters:
        extractorConfig - the extractorConfig value to set.
        Returns:
        the DocumentCollection object itself.

      • getUnvalidatedDocsCount

        public Integer getUnvalidatedDocsCount()
        Get the unvalidatedDocsCount property: Number of unvalidated documents in the collection.
        Returns:
        the unvalidatedDocsCount value.

      • setUnvalidatedDocsCount

        public DocumentCollection setUnvalidatedDocsCount​(Integer unvalidatedDocsCount)
        Set the unvalidatedDocsCount property: Number of unvalidated documents in the collection.
        Parameters:
        unvalidatedDocsCount - the unvalidatedDocsCount value to set.
        Returns:
        the DocumentCollection object itself.

      • getConfirmedDocsCount

        public Integer getConfirmedDocsCount()
        Get the confirmedDocsCount property: Number of validated documents in the collection.
        Returns:
        the confirmedDocsCount value.

      • setConfirmedDocsCount

        public DocumentCollection setConfirmedDocsCount​(Integer confirmedDocsCount)
        Set the confirmedDocsCount property: Number of validated documents in the collection.
        Parameters:
        confirmedDocsCount - the confirmedDocsCount value to set.
        Returns:
        the DocumentCollection object itself.

      • getIngestEmail

        public String getIngestEmail()
        Get the ingestEmail property: When you send email to this address, any document attached in the body will be uploaded to this collection.
        Returns:
        the ingestEmail value.

      • setIngestEmail

        public DocumentCollection setIngestEmail​(String ingestEmail)
        Set the ingestEmail property: When you send email to this address, any document attached in the body will be uploaded to this collection.
        Parameters:
        ingestEmail - the ingestEmail value to set.
        Returns:
        the DocumentCollection object itself.

      • isTailoredExtractorRequested

        public Boolean isTailoredExtractorRequested()
        Get the tailoredExtractorRequested property: Whether a tailored extractor has been requested for this collection.
        Returns:
        the tailoredExtractorRequested value.

      • setTailoredExtractorRequested

        public DocumentCollection setTailoredExtractorRequested​(Boolean tailoredExtractorRequested)
        Set the tailoredExtractorRequested property: Whether a tailored extractor has been requested for this collection.
        Parameters:
        tailoredExtractorRequested - the tailoredExtractorRequested value to set.
        Returns:
        the DocumentCollection object itself.