com.microsoft.azure.kusto.data

Class ClientRequestProperties

java.lang.Object

com.microsoft.azure.kusto.data.ClientRequestProperties

All Implemented Interfaces:

TraceableAttributes, Serializable

public class ClientRequestProperties
extends Object
implements Serializable, TraceableAttributes

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	KUSTO_TIMESPAN_REGEX
static String	OPTION_CLIENT_MAX_REDIRECT_COUNT
static String	OPTION_NO_REQUEST_TIMEOUT
static String	OPTION_SERVER_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ClientRequestProperties()

Method Summary

Modifier and Type	Method and Description
void	clearOptions()
void	clearParameters()
static ClientRequestProperties	fromString(String json)
String	getApplication() Gets the application name for tracing purposes.
String	getClientRequestId()
Object	getOption(String name)
Object	getParameter(String name)
int	getRedirectCount()
Long	getTimeoutInMilliSec() Gets the amount of time a query may execute on the service before it times out.
Map<String,String>	getTracingAttributes()
String	getUser() Gets the application version for tracing purposes.
void	removeOption(String name)
void	removeParameter(String name)
void	setApplication(String application) Sets the application name for tracing purposes.
void	setClientRequestId(String clientRequestId)
void	setOption(String name, Object value)
void	setParameter(String name, boolean value)
void	setParameter(String name, Date value)
void	setParameter(String name, double value)
void	setParameter(String name, Duration value)
void	setParameter(String name, int value)
void	setParameter(String name, LocalDateTime value)
void	setParameter(String name, long value)
void	setParameter(String name, Object value)
void	setParameter(String name, String value)
void	setParameter(String name, UUID value)
void	setTimeoutInMilliSec(Long timeoutInMs) Sets the amount of time a query may execute on the service before it times out.
void	setUser(String user) Sets the application username for tracing purposes.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_SERVER_TIMEOUT

public static final String OPTION_SERVER_TIMEOUT

See Also:

Constant Field Values

OPTION_NO_REQUEST_TIMEOUT

public static final String OPTION_NO_REQUEST_TIMEOUT

See Also:

Constant Field Values

OPTION_CLIENT_MAX_REDIRECT_COUNT

public static final String OPTION_CLIENT_MAX_REDIRECT_COUNT

See Also:

Constant Field Values

KUSTO_TIMESPAN_REGEX

public static final Pattern KUSTO_TIMESPAN_REGEX

Constructor Detail

ClientRequestProperties

public ClientRequestProperties()

Method Detail

setOption

public void setOption(String name,
                      Object value)

getOption

public Object getOption(String name)

getRedirectCount

public int getRedirectCount()

removeOption

public void removeOption(String name)

clearOptions

public void clearOptions()

setParameter

public void setParameter(String name,
                         Object value)

setParameter

public void setParameter(String name,
                         String value)

setParameter

public void setParameter(String name,
                         Date value)

setParameter

public void setParameter(String name,
                         LocalDateTime value)

setParameter

public void setParameter(String name,
                         Duration value)

setParameter

public void setParameter(String name,
                         boolean value)

setParameter

public void setParameter(String name,
                         int value)

setParameter

public void setParameter(String name,
                         long value)

setParameter

public void setParameter(String name,
                         double value)

setParameter

public void setParameter(String name,
                         UUID value)

getParameter

public Object getParameter(String name)

removeParameter

public void removeParameter(String name)

clearParameters

public void clearParameters()

getTimeoutInMilliSec

public Long getTimeoutInMilliSec()

Gets the amount of time a query may execute on the service before it times out. Value must be between 1 second and 1 hour, and so if the value had been set below the minimum or above the maximum, the value returned will be adjusted accordingly.

setTimeoutInMilliSec

public void setTimeoutInMilliSec(Long timeoutInMs)

Sets the amount of time a query may execute on the service before it times out.

Parameters:

timeoutInMs - number of milliseconds before timeout. Value must be between 1 minute and 1 hour, and so value below the minimum or above the maximum will be adjusted accordingly.

toString

public String toString()

Overrides:

toString in class Object

fromString

public static ClientRequestProperties fromString(String json)
                                          throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getClientRequestId

public String getClientRequestId()

setClientRequestId

public void setClientRequestId(String clientRequestId)

getApplication

public String getApplication()

Gets the application name for tracing purposes. Overrides the application name set in the connection string.

Returns:

The application name.

setApplication

public void setApplication(String application)

Sets the application name for tracing purposes. Overrides the application name set in the connection string.

Parameters:

application - The application name.

getUser

public String getUser()

Gets the application version for tracing purposes. Overrides the application version set in the connection string.

Returns:

The application version.

setUser

public void setUser(String user)

Sets the application username for tracing purposes. Overrides the application username set in the connection string.

Parameters:

user - The application username.

getTracingAttributes

public Map<String,String> getTracingAttributes()

Specified by:

getTracingAttributes in interface TraceableAttributes