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

Class SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder

Object

SynchronizationBatchJsonInJobRequestBuilder

Enclosing class:

SynchronizationBatchJsonInJobRequest

public static final class SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	batchSize(int batchSize)	Sets the size of the batch.
SynchronizationBatchJsonInJobRequest	build()
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	deleteFile(boolean deleteFile)	Sets whether the JSON file should be deleted after the synchronization job is finished, regardless of the result.
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	file(File file)	Sets the JSON file to upload.
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	fileId(UUID fileId)	Sets the id of uploaded JSON file.
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	fileName(String fileName)	Sets the name of the JSON file to upload.
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	relationsAction(String relationsAction)
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	saveResult(boolean saveResult)
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	sendNotification(boolean sendNotification)	Sets whether job status notification should be sent.
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	simulation(boolean simulation)	Sets whether the synchronization should be triggered as a simulation.
SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder	synchronizationId(String synchronizationId)	(required) Sets the synchronization id used to distinguish different synchronizations.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

synchronizationId

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder synchronizationId(String synchronizationId)

(required) Sets the synchronization id used to distinguish different synchronizations.

Parameters:

synchronizationId - the synchronization id used to distinguish different synchronizations

fileId

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder fileId(UUID fileId)

Sets the id of uploaded JSON file.

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

Parameters:

fileId - the id of uploaded JSON file

file

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder file(File file)

Sets the JSON file to upload. If set, then also FileImportRequest.fileName should be provided.

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

Parameters:

file - the JSON file to upload

fileName

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder fileName(String fileName)

Sets the name of the JSON file to upload. If set, then also FileImportRequest.file should be provided.

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

Parameters:

fileName - the name of the JSON file to upload

deleteFile

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder deleteFile(boolean deleteFile)

Sets whether the JSON file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.

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

Parameters:

deleteFile - whether the JSON file should be deleted after the synchronization job is finished

sendNotification

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder sendNotification(boolean sendNotification)

Sets whether job status notification should be sent. The default value is false.

Parameters:

sendNotification - whether job status notification should be sent

batchSize

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder batchSize(int batchSize)

Sets the size of the batch. The default value is 1000.

Parameters:

batchSize - the size of the batch

simulation

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder simulation(boolean simulation)

Sets whether the synchronization should be triggered as a simulation. The default value is false.

If true, the result of the synchronization simulation will be available at the end of the job but no change will be applied to the DGC.

Parameters:

simulation - whether the synchronization should be triggered as a simulation

saveResult

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder saveResult(boolean saveResult)

Parameters:

saveResult - determine if we should save import result in jobs table in message column.

relationsAction

public SynchronizationBatchJsonInJobRequest.SynchronizationBatchJsonInJobRequestBuilder relationsAction(String relationsAction)

Parameters:

relationsAction - define the relations action during refresh to replace or add/update

build

public SynchronizationBatchJsonInJobRequest build()