Package com.microsoft.azure.kusto.ingest

Class IngestClientBase

java.lang.Object

com.microsoft.azure.kusto.ingest.IngestClientBase

All Implemented Interfaces:

IngestClient, Closeable, AutoCloseable

Direct Known Subclasses:

ManagedStreamingIngestClient, QueuedIngestClientImpl, StreamingIngestClient

public abstract class IngestClientBase
extends Object
implements IngestClient

Constructor Summary

Constructors

Constructor	Description
IngestClientBase()

Method Summary

Modifier and Type	Method	Description
protected abstract String	getClientType()
protected Map<String,String>	getIngestionTraceAttributes(TraceableAttributes sourceInfo, TraceableAttributes ingestionProperties)
IngestionResult	ingestFromBlob(BlobSourceInfo blobSourceInfo, IngestionProperties ingestionProperties)	Ingest data from a blob storage into Kusto database.
protected abstract IngestionResult	ingestFromBlobImpl(BlobSourceInfo blobSourceInfo, IngestionProperties ingestionProperties)	Ingest data from a blob storage into Kusto database.
IngestionResult	ingestFromFile(FileSourceInfo fileSourceInfo, IngestionProperties ingestionProperties)	Ingest data from a file into Kusto database.
protected abstract IngestionResult	ingestFromFileImpl(FileSourceInfo fileSourceInfo, IngestionProperties ingestionProperties)
IngestionResult	ingestFromResultSet(ResultSetSourceInfo resultSetSourceInfo, IngestionProperties ingestionProperties)	Ingest data from a Result Set into Kusto database.
protected abstract IngestionResult	ingestFromResultSetImpl(ResultSetSourceInfo resultSetSourceInfo, IngestionProperties ingestionProperties)	Ingest data from a Result Set into Kusto database.
IngestionResult	ingestFromStream(StreamSourceInfo streamSourceInfo, IngestionProperties ingestionProperties)	Ingest data from an input stream, into Kusto database.
protected abstract IngestionResult	ingestFromStreamImpl(StreamSourceInfo streamSourceInfo, IngestionProperties ingestionProperties)	Ingest data from an input stream, into Kusto database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Constructor Detail

IngestClientBase

public IngestClientBase()

Method Detail

ingestFromFileImpl

protected abstract IngestionResult ingestFromFileImpl(FileSourceInfo fileSourceInfo,
                                                      IngestionProperties ingestionProperties)
                                               throws IngestionClientException,
                                                      IngestionServiceException

Throws:

IngestionClientException

IngestionServiceException

ingestFromFile

public IngestionResult ingestFromFile(FileSourceInfo fileSourceInfo,
                                      IngestionProperties ingestionProperties)
                               throws IngestionClientException,
                                      IngestionServiceException

Description copied from interface: IngestClient

Ingest data from a file into Kusto database.

This method ingests the data from a given file, described in fileSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Specified by:

ingestFromFile in interface IngestClient

Parameters:

fileSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

FileSourceInfo, IngestionProperties

ingestFromBlobImpl

protected abstract IngestionResult ingestFromBlobImpl(BlobSourceInfo blobSourceInfo,
                                                      IngestionProperties ingestionProperties)
                                               throws IngestionClientException,
                                                      IngestionServiceException

Ingest data from a blob storage into Kusto database.

This method ingests the data from a given blob, described in blobSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Parameters:

blobSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

BlobSourceInfo, IngestionProperties

ingestFromBlob

public IngestionResult ingestFromBlob(BlobSourceInfo blobSourceInfo,
                                      IngestionProperties ingestionProperties)
                               throws IngestionClientException,
                                      IngestionServiceException

Description copied from interface: IngestClient

Ingest data from a blob storage into Kusto database.

This method ingests the data from a given blob, described in blobSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Specified by:

ingestFromBlob in interface IngestClient

Parameters:

blobSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

BlobSourceInfo, IngestionProperties

ingestFromResultSetImpl

protected abstract IngestionResult ingestFromResultSetImpl(ResultSetSourceInfo resultSetSourceInfo,
                                                           IngestionProperties ingestionProperties)
                                                    throws IngestionClientException,
                                                           IngestionServiceException

Ingest data from a Result Set into Kusto database.

This method ingests the data from a given Result Set, described in resultSetSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Ingesting from ResultSet is equivalent to ingesting from a csv stream. The DataFormat should be empty or set to "csv", and the mapping, should it be provided, should be csv mapping.

Parameters:

resultSetSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

ResultSetSourceInfo, IngestionProperties

ingestFromResultSet

public IngestionResult ingestFromResultSet(ResultSetSourceInfo resultSetSourceInfo,
                                           IngestionProperties ingestionProperties)
                                    throws IngestionClientException,
                                           IngestionServiceException

Description copied from interface: IngestClient

Ingest data from a Result Set into Kusto database.

This method ingests the data from a given Result Set, described in resultSetSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Ingesting from ResultSet is equivalent to ingesting from a csv stream. The DataFormat should be empty or set to "csv", and the mapping, should it be provided, should be csv mapping.

Specified by:

ingestFromResultSet in interface IngestClient

Parameters:

resultSetSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

ResultSetSourceInfo, IngestionProperties

ingestFromStreamImpl

protected abstract IngestionResult ingestFromStreamImpl(StreamSourceInfo streamSourceInfo,
                                                        IngestionProperties ingestionProperties)
                                                 throws IngestionClientException,
                                                        IngestionServiceException

Ingest data from an input stream, into Kusto database.

This method ingests the data from a given input stream, described in streamSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Parameters:

streamSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

StreamSourceInfo, IngestionProperties

ingestFromStream

public IngestionResult ingestFromStream(StreamSourceInfo streamSourceInfo,
                                        IngestionProperties ingestionProperties)
                                 throws IngestionClientException,
                                        IngestionServiceException

Description copied from interface: IngestClient

Ingest data from an input stream, into Kusto database.

This method ingests the data from a given input stream, described in streamSourceInfo, into Kusto database, according to the properties mentioned in ingestionProperties

Specified by:

ingestFromStream in interface IngestClient

Parameters:

streamSourceInfo - The specific SourceInfo to be ingested

ingestionProperties - Settings used to customize the ingestion operation

Returns:

IngestionResult object including the ingestion result

Throws:

IngestionClientException - An exception originating from a client activity

IngestionServiceException - An exception returned from the service

See Also:

StreamSourceInfo, IngestionProperties

getIngestionTraceAttributes

protected Map<String,String> getIngestionTraceAttributes(TraceableAttributes sourceInfo,
                                                               TraceableAttributes ingestionProperties)

getClientType

protected abstract String getClientType()