Package com.affinda.api.client.models

Class DocumentCreate

  • public final class DocumentCreate
extends Object
    The DocumentCreate model.

    • Constructor Detail

      • DocumentCreate

        public DocumentCreate()

    • Method Detail

      • getFile

        public reactor.core.publisher.Flux<ByteBuffer> getFile()
        Get the file property: File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG.
        Returns:
        the file value.

      • setFile

        public DocumentCreate setFile​(reactor.core.publisher.Flux<ByteBuffer> file)
        Set the file property: File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG.
        Parameters:
        file - the file value to set.
        Returns:
        the DocumentCreate object itself.

      • getUrl

        public String getUrl()
        Get the url property: URL to download the document.
        Returns:
        the url value.

      • setUrl

        public DocumentCreate setUrl​(String url)
        Set the url property: URL to download the document.
        Parameters:
        url - the url value to set.
        Returns:
        the DocumentCreate object itself.

      • getCollection

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

      • setCollection

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

      • getWorkspace

        public String getWorkspace()
        Get the workspace property: Uniquely identify a workspace.
        Returns:
        the workspace value.

      • setWorkspace

        public DocumentCreate setWorkspace​(String workspace)
        Set the workspace property: Uniquely identify a workspace.
        Parameters:
        workspace - the workspace value to set.
        Returns:
        the DocumentCreate object itself.

      • isWait

        public Boolean isWait()
        Get the wait property: If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.
        Returns:
        the wait value.

      • setWait

        public DocumentCreate setWait​(Boolean wait)
        Set the wait property: If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.
        Parameters:
        wait - the wait value to set.
        Returns:
        the DocumentCreate object itself.

      • getIdentifier

        public String getIdentifier()
        Get the identifier property: Specify a custom identifier for the document.
        Returns:
        the identifier value.

      • setIdentifier

        public DocumentCreate setIdentifier​(String identifier)
        Set the identifier property: Specify a custom identifier for the document.
        Parameters:
        identifier - the identifier value to set.
        Returns:
        the DocumentCreate object itself.

      • getFileName

        public String getFileName()
        Get the fileName property: Optional filename of the file.
        Returns:
        the fileName value.

      • setFileName

        public DocumentCreate setFileName​(String fileName)
        Set the fileName property: Optional filename of the file.
        Parameters:
        fileName - the fileName value to set.
        Returns:
        the DocumentCreate object itself.

      • getExpiryTime

        public java.time.OffsetDateTime getExpiryTime()
        Get the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
        Returns:
        the expiryTime value.

      • setExpiryTime

        public DocumentCreate setExpiryTime​(java.time.OffsetDateTime expiryTime)
        Set the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
        Parameters:
        expiryTime - the expiryTime value to set.
        Returns:
        the DocumentCreate object itself.

      • getLanguage

        public String getLanguage()
        Get the language property: Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
        Returns:
        the language value.

      • setLanguage

        public DocumentCreate setLanguage​(String language)
        Set the language property: Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
        Parameters:
        language - the language value to set.
        Returns:
        the DocumentCreate object itself.

      • isRejectDuplicates

        public Boolean isRejectDuplicates()
        Get the rejectDuplicates property: If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
        Returns:
        the rejectDuplicates value.

      • setRejectDuplicates

        public DocumentCreate setRejectDuplicates​(Boolean rejectDuplicates)
        Set the rejectDuplicates property: If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
        Parameters:
        rejectDuplicates - the rejectDuplicates value to set.
        Returns:
        the DocumentCreate object itself.

      • getRegionBias

        public String getRegionBias()
        Get the regionBias property: A JSON representation of the RegionBias object.
        Returns:
        the regionBias value.

      • setRegionBias

        public DocumentCreate setRegionBias​(String regionBias)
        Set the regionBias property: A JSON representation of the RegionBias object.
        Parameters:
        regionBias - the regionBias value to set.
        Returns:
        the DocumentCreate object itself.

      • isLowPriority

        public Boolean isLowPriority()
        Get the lowPriority property: Explicitly mark this document as low priority.
        Returns:
        the lowPriority value.

      • setLowPriority

        public DocumentCreate setLowPriority​(Boolean lowPriority)
        Set the lowPriority property: Explicitly mark this document as low priority.
        Parameters:
        lowPriority - the lowPriority value to set.
        Returns:
        the DocumentCreate object itself.