Class ImportCsvInJobRequest.ImportCsvInJobRequestBuilder
Object
ImportCsvInJobRequestBuilder
- Enclosing class:
ImportCsvInJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionbatchSize
(int batchSize) Sets the size of the batch.build()
deleteFile
(boolean deleteFile) Sets whether the CSV file should be deleted after the import job is finished, regardless of the result.Sets the delimiter character used to escape separator or quote character.Sets the CSV file to upload.Sets theid
of uploaded CSV file.Sets the name of the CSV file to upload.headerRow
(boolean headerRow) Sets whether the first row of the imported CSV file is the header.ignoreLeadingWhitespace
(boolean ignoreLeadingWhitespace) Sets whether whitespace characters before quotes should be ignored.Sets the delimiter character used for quoted entries.sendNotification
(boolean sendNotification) Sets whether job status notification should be sent.Sets the delimiter character used to separate entries.simulation
(boolean simulation) Sets whether the import should be triggered as a simulation.strictQuotes
(boolean strictQuotes) Sets whether the characters outside quotes should be ignored.Sets the template that should be used for parsing and importing the contents of the CSV file.
-
Method Details
-
separator
Sets the delimiter character used to separate entries. The default value is';'
.- Parameters:
separator
- the delimiter character used to separate entries
-
quote
Sets the delimiter character used for quoted entries. The default value is'"'
.- Parameters:
quote
- the delimiter character used for quoted entries
-
escape
Sets the delimiter character used to escape separator or quote character. The default value is'\\'
.- Parameters:
escape
- the delimiter character used to escape separator or quote character
-
strictQuotes
Sets whether the characters outside quotes should be ignored. The default value isfalse
.- Parameters:
strictQuotes
- whether the characters outside quotes should be ignored
-
ignoreLeadingWhitespace
public ImportCsvInJobRequest.ImportCsvInJobRequestBuilder ignoreLeadingWhitespace(boolean ignoreLeadingWhitespace) Sets whether whitespace characters before quotes should be ignored. The default value isfalse
.- Parameters:
ignoreLeadingWhitespace
- whether whitespace characters before quotes should be ignored
-
headerRow
Sets whether the first row of the imported CSV file is the header. The default value isfalse
.- Parameters:
headerRow
- whether the first row of the imported CSV file is the header
-
template
Sets the template that should be used for parsing and importing the contents of the CSV file.There is one placeholder currently supported:
- ${x} - refers to the x-th column in the CSV 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 importing the contents of the CSV file
-
fileId
Sets theid
of uploaded CSV file.NOTE: if this field is used,
FileImportRequest.file
should not be set.- Parameters:
fileId
- theid
of uploaded CSV file
-
file
Sets the CSV 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 CSV file to upload
-
fileName
Sets the name of the CSV 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 CSV file to upload
-
deleteFile
Sets whether the CSV file should be deleted after the import job is finished, regardless of the result. The default value isfalse
.NOTE: if the CSV file corresponds to an attachment, the attachment will be deleted. When import operation fails then file will not be deleted.
- Parameters:
deleteFile
- whether the CSV file should be deleted after the import job is finished
-
sendNotification
public ImportCsvInJobRequest.ImportCsvInJobRequestBuilder 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
Sets the size of the batch. The default value is1000
.- Parameters:
batchSize
- the size of the batch
-
simulation
Sets whether the import should be triggered as a simulation. The default value isfalse
.If
true
, the result of the import simulation will be available at the end of the job but no change will be applied to the DGC.- Parameters:
simulation
- whether the import should be triggered as a simulation
-
build
-