IngestionProperties (Kusto ingest client library 5.0.4 API)

java.lang.Object
- com.microsoft.azure.kusto.ingest.IngestionProperties

All Implemented Interfaces:: TraceableAttributes

public class IngestionProperties
extends Object
implements TraceableAttributes

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IngestionProperties.DataFormat`
`static class`	`IngestionProperties.IngestionReportLevel`
`static class`	`IngestionProperties.IngestionReportMethod`

Constructor Summary

Constructors
Constructor and Description
`IngestionProperties(IngestionProperties other)` Copy constructor for `IngestionProperties`.
`IngestionProperties(String databaseName, String tableName)` Creates an initialized `IngestionProperties` instance with a given `databaseName` and `tableName`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAdditionalProperties()`
`List<String>`	`getAdditionalTags()`
`String`	`getDatabaseName()`
`@NotNull IngestionProperties.DataFormat`	`getDataFormat()` Returns the DataFormat
`List<String>`	`getDropByTags()`
`boolean`	`getFlushImmediately()`
`List<String>`	`getIngestByTags()`
`List<String>`	`getIngestIfNotExists()`
`IngestionMapping`	`getIngestionMapping()`
`IngestionProperties.IngestionReportLevel`	`getReportLevel()`
`IngestionProperties.IngestionReportMethod`	`getReportMethod()`
`String`	`getTableName()`
`Map<String,String>`	`getTracingAttributes()`
`ValidationPolicy`	`getValidationPolicy()`
`boolean`	`isIgnoreFirstRecord()`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setAdditionalTags(List<String> additionalTags)` Customized tags
`void`	`setAuthorizationContextToken(String token)`
`void`	`setDataFormat(@NotNull IngestionProperties.DataFormat dataFormat)` Sets the data format.
`void`	`setDataFormat(@NotNull String dataFormatName)` Sets the data format by its name.
`void`	`setDropByTags(List<String> dropByTags)` Drop-by tags are tags added to the ingested data bulk inorder to be able to delete it.
`void`	`setFlushImmediately(boolean flushImmediately)`
`void`	`setIgnoreFirstRecord(boolean ignoreFirstRecord)`
`void`	`setIngestByTags(List<String> ingestByTags)` Tags that start with an ingest-by: prefix can be used to ensure that data is only ingested once.
`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
`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:
`void`	`setIngestionMapping(IngestionMapping ingestionMapping)`
`void`	`setIngestionMapping(String mappingReference, IngestionMapping.IngestionMappingKind ingestionMappingKind)` Sets the predefined ingestion mapping name:
`void`	`setReportLevel(IngestionProperties.IngestionReportLevel reportLevel)`
`void`	`setReportMethod(IngestionProperties.IngestionReportMethod reportMethod)`
`void`	`setValidationPolicy(ValidationPolicy validationPolicy)`
`void`	`validateResultSetProperties()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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
  - getValidationPolicy
```
public ValidationPolicy getValidationPolicy()
```
  - 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)
```
  - getReportLevel
```
public IngestionProperties.IngestionReportLevel getReportLevel()
```
  - setReportLevel
```
public void setReportLevel(IngestionProperties.IngestionReportLevel reportLevel)
```
  - getReportMethod
```
public IngestionProperties.IngestionReportMethod getReportMethod()
```
  - setReportMethod
```
public void setReportMethod(IngestionProperties.IngestionReportMethod reportMethod)
```
  - 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 IngestionProperties.DataFormat dataFormat)
```
    Sets the data format.
    
    Parameters:
    
    dataFormat - One of the values in: DataFormat
    
    Throws:
    
    IllegalArgumentException - if null argument is passed
  - 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
  - getDataFormat
```
@NotNull
public @NotNull IngestionProperties.DataFormat getDataFormat()
```
    Returns the DataFormat
    
    Returns:
    
    The 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)
```
  - getIngestionMapping
```
public IngestionMapping getIngestionMapping()
```
  - setAuthorizationContextToken
```
public void setAuthorizationContextToken(String token)
```
  - validateResultSetProperties
```
public void validateResultSetProperties()
                                 throws IngestionClientException
```
    Throws:
    
    IngestionClientException
  - getTracingAttributes
```
public Map<String,String> getTracingAttributes()
```
    Specified by:
    
    getTracingAttributes in interface TraceableAttributes

Class IngestionProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IngestionProperties

IngestionProperties

Method Detail

getValidationPolicy

setValidationPolicy

getDatabaseName

getTableName

getFlushImmediately

setFlushImmediately

isIgnoreFirstRecord

setIgnoreFirstRecord

getReportLevel

setReportLevel

getReportMethod

setReportMethod

getDropByTags

setDropByTags

getIngestByTags

setIngestByTags

getAdditionalTags

setAdditionalTags

setAdditionalProperties

getAdditionalProperties

getIngestIfNotExists

setIngestIfNotExists

setDataFormat

setDataFormat

getDataFormat

setIngestionMapping

setIngestionMapping

setIngestionMapping

getIngestionMapping

setAuthorizationContextToken

validateResultSetProperties

getTracingAttributes