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

Class SynchronizationCsvInJobRequest

Object

BaseImportRequest

FileSynchronizationRequest

SynchronizationCsvInJobRequest

All Implemented Interfaces:

Serializable

public class SynchronizationCsvInJobRequest
extends FileSynchronizationRequest

The request defining synchronization call properties from a CSV file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SynchronizationCsvInJobRequest.SynchronizationCsvInJobRequestBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull Character	escape	The delimiter character used to escape separator or quote character.
protected boolean	headerRow	Whether the first row of the synchronized CSV file is the header.
protected boolean	ignoreLeadingWhitespace	Whether whitespace characters before quotes should be ignored.
protected @NotNull Character	quote	The delimiter character used for quoted entries.
protected @NotNull Character	separator	The delimiter character used to separate entries.
protected boolean	strictQuotes	Whether the characters outside quotes should be ignored.
protected @NotBlank String	template	The template that should be used for parsing and synchronizing the contents of the CSV file.

Fields inherited from class FileSynchronizationRequest

continueOnError, deleteFile, file, fileId, fileName, synchronizationId

Fields inherited from class BaseImportRequest

batchSize, DEFAULT_BATCH_SIZE, requestSource, saveResult, sendNotification, simulation

Constructor Summary

Constructors

Constructor	Description
SynchronizationCsvInJobRequest()

Method Summary

Modifier and Type	Method	Description
static SynchronizationCsvInJobRequest.SynchronizationCsvInJobRequestBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NotNull Character	getEscape()	The delimiter character used to escape separator or quote character.
@NotNull Character	getQuote()	The delimiter character used for quoted entries.
@NotNull Character	getSeparator()	The delimiter character used to separate entries.
String	getTemplate()	The template that should be used for parsing and synchronizing the contents of the CSV file.
int	hashCode()
boolean	isHeaderRow()	Whether the first row of the synchronized CSV file is the header.
boolean	isIgnoreLeadingWhitespace()	Whether whitespace characters before quotes should be ignored.
boolean	isStrictQuotes()	Whether the characters outside quotes should be ignored.
String	toString()

Methods inherited from class FileSynchronizationRequest

getFile, getFileId, getFileName, getSynchronizationId, isContinueOnError, isDeleteFile, setContinueOnError, setDeleteFile, setFile, setFileId, setFileName, setSynchronizationId

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 Detail

separator

@NotNull
@DefaultValue(";")
protected @NotNull Character separator

The delimiter character used to separate entries. The default value is ';'.

quote

@NotNull
@DefaultValue("\"")
protected @NotNull Character quote

The delimiter character used for quoted entries. The default value is '"'.

escape

@NotNull
@DefaultValue("\\")
protected @NotNull Character escape

The delimiter character used to escape separator or quote character. The default value is '\\'.

strictQuotes

protected boolean strictQuotes

Whether the characters outside quotes should be ignored. The default value is false.

ignoreLeadingWhitespace

protected boolean ignoreLeadingWhitespace

Whether whitespace characters before quotes should be ignored. The default value is false.

headerRow

protected boolean headerRow

Whether the first row of the synchronized CSV file is the header. The default value is false.

template

@NotBlank
protected @NotBlank String template

The template that should be used for parsing and synchronizing the contents of the CSV file.

There is one placeholder currently supported:

• ${x} - refers to the x-th column in the CSV file, e.g. ${1}, ${2}, ...)

Example of a correct JSON template:

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

Constructor Detail

SynchronizationCsvInJobRequest

public SynchronizationCsvInJobRequest()

Method Detail

builder

public static SynchronizationCsvInJobRequest.SynchronizationCsvInJobRequestBuilder builder()

getSeparator

@NotNull
public @NotNull Character getSeparator()

The delimiter character used to separate entries. The default value is ';'.

getQuote

@NotNull
public @NotNull Character getQuote()

The delimiter character used for quoted entries. The default value is '"'.

getEscape

@NotNull
public @NotNull Character getEscape()

The delimiter character used to escape separator or quote character. The default value is '\\'.

isStrictQuotes

public boolean isStrictQuotes()

Whether the characters outside quotes should be ignored. The default value is false.

isIgnoreLeadingWhitespace

public boolean isIgnoreLeadingWhitespace()

Whether whitespace characters before quotes should be ignored. The default value is false.

isHeaderRow

public boolean isHeaderRow()

Whether the first row of the synchronized CSV file is the header. The default value is false.

getTemplate

public String getTemplate()

The template that should be used for parsing and synchronizing the contents of the CSV file.

There is one placeholder currently supported:

• ${x} - refers to the x-th column in the CSV file, e.g. ${1}, ${2}, ...)

Example of a correct JSON template:

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

toString

public String toString()

Overrides:

toString in class FileSynchronizationRequest

equals

public boolean equals(Object o)

Overrides:

equals in class FileSynchronizationRequest

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class FileSynchronizationRequest

hashCode

public int hashCode()

Overrides:

hashCode in class FileSynchronizationRequest