Class FileImportRequest

Object
BaseImportRequest
FileImportRequest
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ImportCsvInJobRequest, ImportExcelInJobRequest, ImportJsonInJobRequest

public class FileImportRequest extends BaseImportRequest
The properties for an import from a file.
See Also:
  • Field Details Link icon

    • fileId Link icon

      protected UUID fileId
      The id of uploaded file.

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

    • file Link icon

      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 Link icon

      @DefaultValue("import_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 Link icon

      @DefaultValue("false") protected boolean deleteFile
      Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false.

      NOTE: if the file corresponds to an attachment, the attachment will be deleted.

    • continueOnError Link icon

      @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 Details Link icon

    • FileImportRequest Link icon

      protected FileImportRequest()
  • Method Details Link icon

    • getFileId Link icon

      public UUID getFileId()
      The id of uploaded file.

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

    • getFile Link icon

      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 Link icon

      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 Link icon

      public boolean isDeleteFile()
      Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false.

      NOTE: if the file corresponds to an attachment, the attachment will be deleted.

    • isContinueOnError Link icon

      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.

    • setFileId Link icon

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

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

    • setFile Link icon

      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 Link icon

      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 Link icon

      public void setDeleteFile(boolean deleteFile)
      Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false.

      NOTE: if the file corresponds to an attachment, the attachment will be deleted.

    • setContinueOnError Link icon

      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.

    • toString Link icon

      public String toString()
      Overrides:
      toString in class BaseImportRequest
    • equals Link icon

      public boolean equals(Object o)
      Overrides:
      equals in class BaseImportRequest
    • canEqual Link icon

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseImportRequest
    • hashCode Link icon

      public int hashCode()
      Overrides:
      hashCode in class BaseImportRequest