Class SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder
- Object
-
- SynchronizationJsonInJobRequestBuilder
-
- Enclosing class:
- SynchronizationJsonInJobRequest
public static final class SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder.CustomFinalizationParameter
-
Method Summary
-
-
-
Method Detail
-
synchronizationId
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder synchronizationId(String synchronizationId)
(required) Sets the synchronizationid
used to distinguish different synchronizations.- Parameters:
synchronizationId
- the synchronizationid
used to distinguish different synchronizations
-
fileId
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder fileId(UUID fileId)
Sets theid
of uploaded JSON file.NOTE: if this field is used,
FileImportRequest.file
should not be set.- Parameters:
fileId
- theid
of uploaded JSON file
-
file
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder file(File file)
Sets the JSON file to upload. If set, then alsoFileImportRequest.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 SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder fileName(String fileName)
Sets the name of the JSON file to upload. If set, then alsoFileImportRequest.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 SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder deleteFile(boolean deleteFile)
Sets whether the JSON file should be deleted after the synchronization job is finished, regardless of the result. The default value isfalse
.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 SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder sendNotification(boolean sendNotification)
Sets whether job status notification should be sent. The default value isfalse
.- Parameters:
sendNotification
- whether job status notification should be sent
-
batchSize
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder batchSize(int batchSize)
Sets the size of the batch. The default value is1000
.- Parameters:
batchSize
- the size of the batch
-
simulation
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder simulation(boolean simulation)
Sets whether the synchronization should be triggered as a simulation. The default value isfalse
.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 SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder saveResult(boolean saveResult)
- Parameters:
saveResult
- determine if we should save import result in jobs table in message column.
-
finalizationStrategy
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder finalizationStrategy(String finalizationType)
Sets the finalization type.- Parameters:
finalizationType
- the finalization type used to define clean up action
-
missingAssetStatusId
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder missingAssetStatusId(UUID missingAssetStatusId)
-
addFinalizationParameter
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder addFinalizationParameter(SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder.CustomFinalizationParameter key, String value)
Add a custom finalization status id parameter.- Parameters:
key
- parameter typevalue
- parameter value
-
relationsAction
public SynchronizationJsonInJobRequest.SynchronizationJsonInJobRequestBuilder relationsAction(String relationsAction)
- Parameters:
relationsAction
- define the relations action during refresh to replace or add/update
-
build
public SynchronizationJsonInJobRequest build()
-
-