Class FileSynchronizationRequest

    • Field Detail

      • synchronizationId

        @Size(min=1,
              max=50)
        @NotNull
        @PathParam("synchronizationId")
        protected @Size(min=1,max=50) @NotNull String synchronizationId
        The synchronization id used to distinguish different synchronizations.
      • fileId

        protected UUID fileId
        The id of uploaded file.

        NOTE: if this field is used, file should not be set.

      • file

        protected File file
        The file to upload. If set, then also fileName should be provided.

        NOTE: if this field is used, fileId should not be set.

      • fileName

        @DefaultValue("synchronization_file")
        protected String fileName
        The name of the file to upload. If set, then also file should be provided.

        NOTE: if this field is used, fileId should not be set.

      • deleteFile

        @DefaultValue("false")
        protected boolean deleteFile
        Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

        NOTE: if the file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.

      • continueOnError

        @DefaultValue("false")
        protected boolean continueOnError
        Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

        If true, the valid commands are still committed to the database, which can lead to partial results being stored.

    • Constructor Detail

      • FileSynchronizationRequest

        protected FileSynchronizationRequest()
    • Method Detail

      • getSynchronizationId

        @NotNull
        public @NotNull String getSynchronizationId()
        The synchronization id used to distinguish different synchronizations.
      • getFileId

        public UUID getFileId()
        The id of uploaded file.

        NOTE: if this field is used, file should not be set.

      • getFile

        public File getFile()
        The file to upload. If set, then also fileName should be provided.

        NOTE: if this field is used, fileId should not be set.

      • getFileName

        public String getFileName()
        The name of the file to upload. If set, then also file should be provided.

        NOTE: if this field is used, fileId should not be set.

      • isDeleteFile

        public boolean isDeleteFile()
        Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

        NOTE: if the file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.

      • isContinueOnError

        public boolean isContinueOnError()
        Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

        If true, the valid commands are still committed to the database, which can lead to partial results being stored.

      • setSynchronizationId

        public void setSynchronizationId​(@NotNull
                                         @NotNull String synchronizationId)
        The synchronization id used to distinguish different synchronizations.
      • setFileId

        public void setFileId​(UUID fileId)
        The id of uploaded file.

        NOTE: if this field is used, file should not be set.

      • setFile

        public void setFile​(File file)
        The file to upload. If set, then also fileName should be provided.

        NOTE: if this field is used, fileId should not be set.

      • setFileName

        public void setFileName​(String fileName)
        The name of the file to upload. If set, then also file should be provided.

        NOTE: if this field is used, fileId should not be set.

      • setDeleteFile

        public void setDeleteFile​(boolean deleteFile)
        Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

        NOTE: if the file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.

      • setContinueOnError

        public void setContinueOnError​(boolean continueOnError)
        Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.

        If true, the valid commands are still committed to the database, which can lead to partial results being stored.