Package com.collibra.dgc.importer.api.request

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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	continueOnError	Whether the import should continue if some of the import commands are invalid or failed to execute.
protected boolean	deleteFile	Delete the file from the Collibra Platform if the import / synchronization job is successful.
protected File	file	The file to upload.
protected UUID	fileId	The id of uploaded file.
protected String	fileName	The name of the file to upload.

Fields inherited from class BaseImportRequest

batchSize, DEFAULT_BATCH_SIZE, requestSource, saveResult, sendNotification, simulation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileImportRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
File	getFile()	The file to upload.
UUID	getFileId()	The id of uploaded file.
String	getFileName()	The name of the file to upload.
int	hashCode()
boolean	isContinueOnError()	Whether the import should continue if some of the import commands are invalid or failed to execute.
boolean	isDeleteFile()	Delete the file from the Collibra Platform if the import / synchronization job is successful.
void	setContinueOnError(boolean continueOnError)	Whether the import should continue if some of the import commands are invalid or failed to execute.
void	setDeleteFile(boolean deleteFile)	Delete the file from the Collibra Platform if the import / synchronization job is successful.
void	setFile(File file)	The file to upload.
void	setFileId(UUID fileId)	The id of uploaded file.
void	setFileName(String fileName)	The name of the file to upload.
String	toString()

Methods inherited from class BaseImportRequest

getBatchSize, getRequestSource, isSaveResult, isSendNotification, isSimulation, setBatchSize, setRequestSource, setSaveResult, setSendNotification, setSimulation

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

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("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

@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

@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

FileImportRequest

protected FileImportRequest()

Method Details

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()

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

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

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)

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

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

public String toString()

Overrides:

toString in class BaseImportRequest

equals

public boolean equals(Object o)

Overrides:

equals in class BaseImportRequest

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseImportRequest

hashCode

public int hashCode()

Overrides:

hashCode in class BaseImportRequest