Package com.affinda.api.client.models

Class WorkspaceCreate

  • public final class WorkspaceCreate
extends Object
    The WorkspaceCreate model.

    • Constructor Detail

      • WorkspaceCreate

        public WorkspaceCreate()

    • Method Detail

      • getOrganization

        public String getOrganization()
        Get the organization property: Uniquely identify an organization.
        Returns:
        the organization value.

      • setOrganization

        public WorkspaceCreate setOrganization​(String organization)
        Set the organization property: Uniquely identify an organization.
        Parameters:
        organization - the organization value to set.
        Returns:
        the WorkspaceCreate object itself.

      • getName

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

      • setName

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

      • getVisibility

        public WorkspaceVisibility getVisibility()
        Get the visibility property: Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.
        Returns:
        the visibility value.

      • setVisibility

        public WorkspaceCreate setVisibility​(WorkspaceVisibility visibility)
        Set the visibility property: Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.
        Parameters:
        visibility - the visibility value to set.
        Returns:
        the WorkspaceCreate object itself.

      • isRejectInvalidDocuments

        public Boolean isRejectInvalidDocuments()
        Get the rejectInvalidDocuments property: If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
        Returns:
        the rejectInvalidDocuments value.

      • setRejectInvalidDocuments

        public WorkspaceCreate setRejectInvalidDocuments​(Boolean rejectInvalidDocuments)
        Set the rejectInvalidDocuments property: If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
        Parameters:
        rejectInvalidDocuments - the rejectInvalidDocuments value to set.
        Returns:
        the WorkspaceCreate 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 WorkspaceCreate 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 WorkspaceCreate object itself.

      • getWhitelistIngestAddresses

        public List<String> getWhitelistIngestAddresses()
        Get the whitelistIngestAddresses property: If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "*@eyefind.info".
        Returns:
        the whitelistIngestAddresses value.

      • setWhitelistIngestAddresses

        public WorkspaceCreate setWhitelistIngestAddresses​(List<String> whitelistIngestAddresses)
        Set the whitelistIngestAddresses property: If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "*@eyefind.info".
        Parameters:
        whitelistIngestAddresses - the whitelistIngestAddresses value to set.
        Returns:
        the WorkspaceCreate object itself.