Package com.microsoft.azure.kusto.ingest

Class IngestClientFactory

java.lang.Object

com.microsoft.azure.kusto.ingest.IngestClientFactory

public class IngestClientFactory
extends Object

Method Summary

Modifier and Type	Method	Description
static QueuedIngestClient	createClient(ConnectionStringBuilder csb)	Creates a new queued ingest client, with default http client properties.
static QueuedIngestClient	createClient(ConnectionStringBuilder csb, @Nullable HttpClientProperties properties)	Creates a new queued ingest client.
static QueuedIngestClient	createClient(ConnectionStringBuilder csb, @Nullable HttpClientProperties properties, boolean autoCorrectEndpoint)	Creates a new queued ingest client.
static ManagedStreamingIngestClient	createManagedStreamingIngestClient(ConnectionStringBuilder connectionStringBuilder)	Creates a new managed streaming ingest client, with default http client properties.
static ManagedStreamingIngestClient	createManagedStreamingIngestClient(ConnectionStringBuilder connectionStringBuilder, @Nullable HttpClientProperties properties, boolean autoCorrectEndpoint)	Creates a new managed streaming ingest client.
static ManagedStreamingIngestClient	createManagedStreamingIngestClient(ConnectionStringBuilder ingestionEndpointConnectionStringBuilder, ConnectionStringBuilder queryEndpointConnectionStringBuilder)	Creates a new managed streaming ingest client, with default http client properties.
static ManagedStreamingIngestClient	createManagedStreamingIngestClient(ConnectionStringBuilder ingestionEndpointConnectionStringBuilder, ConnectionStringBuilder queryEndpointConnectionStringBuilder, @Nullable HttpClientProperties properties)	Creates a new managed streaming ingest client.
static ManagedStreamingIngestClient	createManagedStreamingIngestClient(ConnectionStringBuilder ingestionEndpointConnectionStringBuilder, ConnectionStringBuilder queryEndpointConnectionStringBuilder, @Nullable HttpClientProperties properties, boolean autoCorrectEndpoint)	Creates a new managed streaming ingest client.
static ManagedStreamingIngestClient	createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder dmConnectionStringBuilder)	Deprecated. - Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder) instead.
static ManagedStreamingIngestClient	createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder dmConnectionStringBuilder, @Nullable HttpClientProperties properties)	Deprecated. - Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder, HttpClientProperties, boolean) instead.
static ManagedStreamingIngestClient	createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder connectionStringBuilder, @Nullable org.apache.http.impl.client.CloseableHttpClient httpClient)	Creates a new ManagedStreamingIngestClient from a DM connection string.
static ManagedStreamingIngestClient	createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder connectionStringBuilder, @Nullable org.apache.http.impl.client.CloseableHttpClient httpClient, boolean autoCorrectEndpoint)	Creates a new ManagedStreamingIngestClient from a DM connection string.
static ManagedStreamingIngestClient	createManagedStreamingIngestClientFromEngineCsb(ConnectionStringBuilder engineConnectionStringBuilder)	Deprecated. - Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder) instead.
static ManagedStreamingIngestClient	createManagedStreamingIngestClientFromEngineCsb(ConnectionStringBuilder engineConnectionStringBuilder, @Nullable HttpClientProperties properties)	Deprecated. - Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder, HttpClientProperties, boolean) instead.
static StreamingIngestClient	createStreamingIngestClient(ConnectionStringBuilder csb)	Creates a new streaming ingest client, with default http client properties.
static StreamingIngestClient	createStreamingIngestClient(ConnectionStringBuilder csb, @Nullable HttpClientProperties properties)	Creates a new streaming ingest client.
static StreamingIngestClient	createStreamingIngestClient(ConnectionStringBuilder csb, @Nullable HttpClientProperties properties, boolean autoCorrectEndpoint)	Creates a new streaming ingest client.

Methods inherited from class java.lang.Object

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

Method Detail

createClient

public static QueuedIngestClient createClient(ConnectionStringBuilder csb)
                                       throws URISyntaxException

Creates a new queued ingest client, with default http client properties.

Parameters:

csb - connection string builder for the data management endpoint

Returns:

a new queued ingest client

Throws:

URISyntaxException - if the connection string is invalid

createClient

public static QueuedIngestClient createClient(ConnectionStringBuilder csb,
                                              @Nullable
                                              @Nullable HttpClientProperties properties)
                                       throws URISyntaxException

Creates a new queued ingest client.

Parameters:

csb - connection string builder for the data management endpoint

properties - additional properties to configure the http client

Returns:

a new queued ingest client

Throws:

URISyntaxException - if the connection string is invalid

createClient

public static QueuedIngestClient createClient(ConnectionStringBuilder csb,
                                              @Nullable
                                              @Nullable HttpClientProperties properties,
                                              boolean autoCorrectEndpoint)
                                       throws URISyntaxException

Creates a new queued ingest client.

Parameters:

csb - connection string builder for the data management endpoint

properties - additional properties to configure the http client

Returns:

a new queued ingest client

Throws:

URISyntaxException - if the connection string is invalid

createStreamingIngestClient

public static StreamingIngestClient createStreamingIngestClient(ConnectionStringBuilder csb)
                                                         throws URISyntaxException

Creates a new streaming ingest client, with default http client properties.

Parameters:

csb - connection string builder for the engine endpoint

Returns:

a new streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createStreamingIngestClient

public static StreamingIngestClient createStreamingIngestClient(ConnectionStringBuilder csb,
                                                                @Nullable
                                                                @Nullable HttpClientProperties properties)
                                                         throws URISyntaxException

Creates a new streaming ingest client.

Parameters:

csb - connection string builder for the engine endpoint

properties - additional properties to configure the http client

Returns:

a new streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createStreamingIngestClient

public static StreamingIngestClient createStreamingIngestClient(ConnectionStringBuilder csb,
                                                                @Nullable
                                                                @Nullable HttpClientProperties properties,
                                                                boolean autoCorrectEndpoint)
                                                         throws URISyntaxException

Creates a new streaming ingest client.

Parameters:

csb - connection string builder for the engine endpoint

properties - additional properties to configure the http client

Returns:

a new streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClient

public static ManagedStreamingIngestClient createManagedStreamingIngestClient(ConnectionStringBuilder ingestionEndpointConnectionStringBuilder,
                                                                              ConnectionStringBuilder queryEndpointConnectionStringBuilder)
                                                                       throws URISyntaxException

Creates a new managed streaming ingest client, with default http client properties. This method should only be used for advanced cases. If your endpoints are standard, or you do not know, use createManagedStreamingIngestClient(ConnectionStringBuilder) instead.

Parameters:

ingestionEndpointConnectionStringBuilder - connection string builder for the data management endpoint

queryEndpointConnectionStringBuilder - connection string builder for the engine endpoint

Returns:

a new managed streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClient

public static ManagedStreamingIngestClient createManagedStreamingIngestClient(ConnectionStringBuilder ingestionEndpointConnectionStringBuilder,
                                                                              ConnectionStringBuilder queryEndpointConnectionStringBuilder,
                                                                              @Nullable
                                                                              @Nullable HttpClientProperties properties,
                                                                              boolean autoCorrectEndpoint)
                                                                       throws URISyntaxException

Creates a new managed streaming ingest client. This method should only be used for advanced cases. If your endpoints are standard, or you do not know, use createManagedStreamingIngestClient(ConnectionStringBuilder, HttpClientProperties, boolean) instead.

Parameters:

ingestionEndpointConnectionStringBuilder - connection string builder for the data management endpoint

queryEndpointConnectionStringBuilder - connection string builder for the engine endpoint

properties - additional properties to configure the http client

Returns:

a new managed streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClient

public static ManagedStreamingIngestClient createManagedStreamingIngestClient(ConnectionStringBuilder ingestionEndpointConnectionStringBuilder,
                                                                              ConnectionStringBuilder queryEndpointConnectionStringBuilder,
                                                                              @Nullable
                                                                              @Nullable HttpClientProperties properties)
                                                                       throws URISyntaxException

Creates a new managed streaming ingest client. This method should only be used for advanced cases. If your endpoints are standard, or you do not know, use createManagedStreamingIngestClient(ConnectionStringBuilder, HttpClientProperties, boolean) instead.

Parameters:

ingestionEndpointConnectionStringBuilder - connection string builder for the data management endpoint

queryEndpointConnectionStringBuilder - connection string builder for the engine endpoint

properties - additional properties to configure the http client

Returns:

a new managed streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClient

public static ManagedStreamingIngestClient createManagedStreamingIngestClient(ConnectionStringBuilder connectionStringBuilder)
                                                                       throws URISyntaxException

Creates a new managed streaming ingest client, with default http client properties. This method supports both an ingestion and query endpoint, and deduces the other endpoint from the given one.

Parameters:

connectionStringBuilder - connection string builder for the client

Returns:

a new managed streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClient

public static ManagedStreamingIngestClient createManagedStreamingIngestClient(ConnectionStringBuilder connectionStringBuilder,
                                                                              @Nullable
                                                                              @Nullable HttpClientProperties properties,
                                                                              boolean autoCorrectEndpoint)
                                                                       throws URISyntaxException

Creates a new managed streaming ingest client. This method supports both an ingestion and query endpoint, and deduces the other endpoint from the given one.

Parameters:

connectionStringBuilder - connection string builder for the client

properties - additional properties to configure the http client

Returns:

a new managed streaming ingest client

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClientFromEngineCsb

public static ManagedStreamingIngestClient createManagedStreamingIngestClientFromEngineCsb(ConnectionStringBuilder engineConnectionStringBuilder)
                                                                                    throws URISyntaxException

Deprecated.

- Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder) instead. Creates a new ManagedStreamingIngestClient from an engine connection string, with default http client properties. This method infers the DM connection string from the engine connection string. For advanced usage, use ManagedStreamingIngestClient(ConnectionStringBuilder, ConnectionStringBuilder, boolean)

Parameters:

engineConnectionStringBuilder - engine connection string

Returns:

a new ManagedStreamingIngestClient

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClientFromEngineCsb

public static ManagedStreamingIngestClient createManagedStreamingIngestClientFromEngineCsb(ConnectionStringBuilder engineConnectionStringBuilder,
                                                                                           @Nullable
                                                                                           @Nullable HttpClientProperties properties)
                                                                                    throws URISyntaxException

Deprecated.

- Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder, HttpClientProperties, boolean) instead. Creates a new ManagedStreamingIngestClient from an engine connection string. This method infers the DM connection string from the engine connection string. For advanced usage, use ManagedStreamingIngestClient(ConnectionStringBuilder, ConnectionStringBuilder, boolean)

Parameters:

engineConnectionStringBuilder - engine connection string

properties - additional properties to configure the http client

Returns:

a new ManagedStreamingIngestClient

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClientFromDmCsb

public static ManagedStreamingIngestClient createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder dmConnectionStringBuilder)
                                                                                throws URISyntaxException

Deprecated.

- Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder) instead. Creates a new ManagedStreamingIngestClient from a DM connection string, with default http client properties. This method infers the engine connection string from the DM connection string. For advanced usage, use ManagedStreamingIngestClient(ConnectionStringBuilder, ConnectionStringBuilder, boolean)

Parameters:

dmConnectionStringBuilder - dm connection stringbuilder

Returns:

a new ManagedStreamingIngestClient

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClientFromDmCsb

public static ManagedStreamingIngestClient createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder dmConnectionStringBuilder,
                                                                                       @Nullable
                                                                                       @Nullable HttpClientProperties properties)
                                                                                throws URISyntaxException

Deprecated.

- Ingest clients now automatically deduce the endpoint, use createManagedStreamingIngestClient(ConnectionStringBuilder, HttpClientProperties, boolean) instead. Creates a new ManagedStreamingIngestClient from a DM connection string. This method infers the engine connection string from the DM connection string. For advanced usage, use ManagedStreamingIngestClient(ConnectionStringBuilder, ConnectionStringBuilder, boolean)

Parameters:

dmConnectionStringBuilder - dm connection stringbuilder

properties - additional properties to configure the http client

Returns:

a new ManagedStreamingIngestClient

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClientFromDmCsb

public static ManagedStreamingIngestClient createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder connectionStringBuilder,
                                                                                       @Nullable
                                                                                       @Nullable org.apache.http.impl.client.CloseableHttpClient httpClient,
                                                                                       boolean autoCorrectEndpoint)
                                                                                throws URISyntaxException

Creates a new ManagedStreamingIngestClient from a DM connection string. This method infers the engine connection string from the DM connection string. For advanced usage, use ManagedStreamingIngestClient(ConnectionStringBuilder, ConnectionStringBuilder, boolean)

Parameters:

connectionStringBuilder - dm connection string builder

httpClient - HTTP Client to use for service and storage calls

Returns:

a new ManagedStreamingIngestClient

Throws:

URISyntaxException - if the connection string is invalid

createManagedStreamingIngestClientFromDmCsb

public static ManagedStreamingIngestClient createManagedStreamingIngestClientFromDmCsb(ConnectionStringBuilder connectionStringBuilder,
                                                                                       @Nullable
                                                                                       @Nullable org.apache.http.impl.client.CloseableHttpClient httpClient)
                                                                                throws URISyntaxException

Creates a new ManagedStreamingIngestClient from a DM connection string. This method infers the engine connection string from the DM connection string. For advanced usage, use ManagedStreamingIngestClient(ConnectionStringBuilder, ConnectionStringBuilder, boolean)

Parameters:

connectionStringBuilder - dm connection string builder

httpClient - HTTP Client to use for service and storage calls

Returns:

a new ManagedStreamingIngestClient

Throws:

URISyntaxException - if the connection string is invalid