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

Class ImportCsvInJobRequest

  • All Implemented Interfaces:
    Serializable
    public class ImportCsvInJobRequest
extends FileImportRequest
    The request defining import call properties from a CSV file.
    See Also:
    Serialized Form

    • Field Detail

      • DEFAULT_SEPARATOR

        protected static final Character DEFAULT_SEPARATOR

      • DEFAULT_QUOTE

        protected static final Character DEFAULT_QUOTE

      • DEFAULT_ESCAPE

        protected static final Character DEFAULT_ESCAPE

      • 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

        @DefaultValue("false")
protected boolean strictQuotes
        Whether the characters outside quotes should be ignored. The default value is false.

      • ignoreLeadingWhitespace

        @DefaultValue("false")
protected boolean ignoreLeadingWhitespace
        Whether whitespace characters before quotes should be ignored. The default value is false.

      • headerRow

        @DefaultValue("false")
protected boolean headerRow
        Whether the first row of the imported 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 importing 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

      • ImportCsvInJobRequest

        public ImportCsvInJobRequest()

    • Method Detail

      • 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 imported CSV file is the header. The default value is false.

      • getTemplate

        public String getTemplate()
        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, 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"
   }
 ]