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

Class SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder

Object

SynchronizationExcelInJobRequestBuilder

Enclosing class:

SynchronizationExcelInJobRequest

public static final class SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	batchSize(int batchSize)	Sets the size of the batch.
SynchronizationExcelInJobRequest	build()
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	deleteFile(boolean deleteFile)	Sets whether the Excel file should be deleted after the synchronization job is finished, regardless of the result.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	file(File file)	Sets the Excel file to upload.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	fileId(UUID fileId)	Sets the id of uploaded Excel file.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	fileName(String fileName)	Sets the name of the Excel file to upload.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	headerRow(boolean headerRow)	Sets whether the first row of the synchronized Excel file is the header.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	sendNotification(boolean sendNotification)	Sets whether job status notification should be sent.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	sheetIndex(Integer sheetIndex)	Sets the index of the Excel sheet.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	sheetName(String sheetName)	Sets the name of the Excel sheet.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	simulation(boolean simulation)	Sets whether the synchronization should be triggered as a simulation.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	synchronizationId(String synchronizationId)	(required) Sets the synchronization id used to distinguish different synchronizations.
SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder	template(String template)	Sets the template that should be used for parsing and synchronizing the contents of the Excel file.

Methods inherited from class Object

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

Method Detail

synchronizationId

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder synchronizationId(String synchronizationId)

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

Parameters:

synchronizationId - the synchronization id used to distinguish different synchronizations

sheetName

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder sheetName(String sheetName)

Sets the name of the Excel sheet.

If the name is null and SynchronizationExcelInJobRequest.sheetIndex is null, the first sheet of the workbook will be used for the synchronization.

If the name is null and SynchronizationExcelInJobRequest.sheetIndex is not null, the sheet with the index specified by value of SynchronizationExcelInJobRequest.sheetIndex will be used for the synchronization.

Parameters:

sheetName - the name of the sheet

sheetIndex

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder sheetIndex(Integer sheetIndex)

Sets the index of the Excel sheet.

If the index is null and SynchronizationExcelInJobRequest.sheetName is null, the first sheet of the workbook will be used for the synchronization.

If the index is null and SynchronizationExcelInJobRequest.sheetName is not null, the sheet with the name specified by value of SynchronizationExcelInJobRequest.sheetName will be used for the synchronization.

Parameters:

sheetIndex - the index of the sheet

headerRow

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder headerRow(boolean headerRow)

Sets whether the first row of the synchronized Excel file is the header. The default value is false.

Parameters:

headerRow - whether the first row of the synchronized Excel file is the header

template

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder template(String template)

Sets the template that should be used for parsing and synchronizing the contents of the Excel file.

There is one placeholder currently supported:

• ${x} - refers to the x-th column in the Excel file (with numbering starting from 0, e.g. ${0}, ${1}, ...)

Example of a correct JSON template:

 [
   {
     "identifier": {
       "name": "${0}",
       "domain": {
         "name": "${1}",
         "community": {
           "name": "Some Community"
         }
       }
     },
     "attributes" : {
        "00000000-0000-0000-0000-000000003115" : [ {
          "value" : "${2}"
        } ],
        "00000000-0000-0000-0000-000000000222" : [ {
          "value" : "${3}"
        } ]
     },
     "resourceType": "Asset"
   }
 ]
 

Parameters:

template - the template that should be used for parsing and synchronizing the contents of the Excel file

fileId

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder fileId(UUID fileId)

Sets the id of uploaded Excel file.

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

Parameters:

fileId - the id of uploaded Excel file

file

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder file(File file)

Sets the Excel 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 Excel file to upload

fileName

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder fileName(String fileName)

Sets the name of the Excel 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 Excel file to upload

deleteFile

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder deleteFile(boolean deleteFile)

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

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

Parameters:

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

sendNotification

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder 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 SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder batchSize(int batchSize)

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

Parameters:

batchSize - the size of the batch

simulation

public SynchronizationExcelInJobRequest.SynchronizationExcelInJobRequestBuilder 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

build

public SynchronizationExcelInJobRequest build()