Package com.microsoft.azure.kusto.ingest

Class IngestionProperties

  • public class IngestionProperties
extends Object

    • Constructor Detail

      • IngestionProperties

        public IngestionProperties​(String databaseName,
                           String tableName)
        Creates an initialized IngestionProperties instance with a given databaseName and tableName. The default values of the rest of the properties are:

        reportLevel : IngestionReportLevel.FailuresOnly;

        reportMethod : IngestionReportMethod.Queue;

        flushImmediately : false;

        ignoreFirstRecord : false;

        additionalProperties : new HashMap();

        dataFormat : DataFormat.csv;

        Parameters:
        databaseName - the name of the database in the destination Kusto cluster.
        tableName - the name of the table in the destination database.

      • IngestionProperties

        public IngestionProperties​(IngestionProperties other)
        Copy constructor for IngestionProperties.
        Parameters:
        other - the instance to copy from.

    • Method Detail

      • setValidationPolicy

        public void setValidationPolicy​(ValidationPolicy validationPolicy)

      • getDatabaseName

        public String getDatabaseName()

      • getTableName

        public String getTableName()

      • getFlushImmediately

        public boolean getFlushImmediately()

      • setFlushImmediately

        public void setFlushImmediately​(boolean flushImmediately)

      • isIgnoreFirstRecord

        public boolean isIgnoreFirstRecord()

      • setIgnoreFirstRecord

        public void setIgnoreFirstRecord​(boolean ignoreFirstRecord)

      • getDropByTags

        public List<String> getDropByTags()

      • setDropByTags

        public void setDropByTags​(List<String> dropByTags)
        Drop-by tags are tags added to the ingested data bulk inorder to be able to delete it. This should be used with care - See kusto docs
        Parameters:
        dropByTags - - suffixes tags list to tag the data being ingested, the resulted tag will be trailed by "drop-by"

      • getIngestByTags

        public List<String> getIngestByTags()

      • setIngestByTags

        public void setIngestByTags​(List<String> ingestByTags)
        Tags that start with an ingest-by: prefix can be used to ensure that data is only ingested once. This should be used with care - See kusto docs
        Parameters:
        ingestByTags - - suffixes tags list to tag the data being ingested, the resulted tag will be trailed by "ingest-by"

      • getAdditionalTags

        public List<String> getAdditionalTags()

      • setAdditionalTags

        public void setAdditionalTags​(List<String> additionalTags)
        Customized tags
        Parameters:
        additionalTags - list of custom user tags

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​String> additionalProperties)
        Parameters:
        additionalProperties - - Set additional properties to the ingestion properties

      • getAdditionalProperties

        public Map<String,​String> getAdditionalProperties()

      • getIngestIfNotExists

        public List<String> getIngestIfNotExists()

      • setIngestIfNotExists

        public void setIngestIfNotExists​(List<String> ingestIfNotExists)
        Will trigger a check if there's already an extent with this specific "ingest-by" tag prefix See kusto docs
        Parameters:
        ingestIfNotExists - list of ingestIfNotExists tags

      • setDataFormat

        public void setDataFormat​(@NotNull
                          @NotNull String dataFormatName)
        Sets the data format by its name. If the name does not exist, then it does not set it.
        Parameters:
        dataFormatName - One of the string values in: DataFormat

      • setIngestionMapping

        public void setIngestionMapping​(String mappingReference,
                                IngestionMapping.IngestionMappingKind ingestionMappingKind)
        Sets the predefined ingestion mapping name:
        Parameters:
        mappingReference - The name of the mapping declared in the destination Kusto database, that describes the mapping between fields of an object and columns of a Kusto table.
        ingestionMappingKind - The data format of the object to map.

      • setIngestionMapping

        public void setIngestionMapping​(ColumnMapping[] columnMappings,
                                IngestionMapping.IngestionMappingKind ingestionMappingKind)
        Please use a mappingReference for production as passing the mapping every time is wasteful Creates an ingestion mapping using the described column mappings:
        Parameters:
        columnMappings - The columnMapping used for this ingestion.
        ingestionMappingKind - The data format of the object to map.

      • setIngestionMapping

        public void setIngestionMapping​(IngestionMapping ingestionMapping)

      • setAuthorizationContextToken

        public void setAuthorizationContextToken​(String token)