Package com.clickhouse.client.http.config

Enum ClickHouseHttpOption

java.lang.Object

java.lang.Enum<ClickHouseHttpOption>

com.clickhouse.client.http.config.ClickHouseHttpOption

All Implemented Interfaces:

com.clickhouse.config.ClickHouseOption, Serializable, Comparable<ClickHouseHttpOption>, java.lang.constant.Constable

public enum ClickHouseHttpOption
extends Enum<ClickHouseHttpOption>
implements com.clickhouse.config.ClickHouseOption

Http client options.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTION_PROVIDER	HTTP connection provider.
CUSTOM_HEADERS	Custom HTTP headers.
CUSTOM_PARAMS	Custom HTTP query parameters.
DEFAULT_RESPONSE	Default server response.
KEEP_ALIVE	Whether to enable keep-alive or not.
MAX_OPEN_CONNECTIONS	Max open connections apply with Apache HttpClient only.
RECEIVE_QUERY_PROGRESS	Whether to receive information about the progress of a query in response headers.
REMEMBER_LAST_SET_ROLES	Whether to remember last set role and send them in every next requests as query parameters.
SEND_HTTP_CLIENT_ID	Indicates whether http client would send its identification through Referer header to server.

Method Summary

Modifier and Type	Method	Description
Serializable	getDefaultValue()
String	getDescription()
String	getKey()
Class<? extends Serializable>	getValueType()
boolean	isSensitive()
static ClickHouseHttpOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClickHouseHttpOption[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.clickhouse.config.ClickHouseOption

getDefaultValueFromEnvVar, getDefaultValueFromSysProp, getEffectiveDefaultValue, getEffectiveValue, getEnvironmentVariable, getPrefix, getSystemProperty, name

Enum Constant Details

CONNECTION_PROVIDER

public static final ClickHouseHttpOption CONNECTION_PROVIDER

HTTP connection provider.

CUSTOM_HEADERS

public static final ClickHouseHttpOption CUSTOM_HEADERS

Custom HTTP headers.

CUSTOM_PARAMS

public static final ClickHouseHttpOption CUSTOM_PARAMS

Custom HTTP query parameters. Consider ClickHouseClientOption.CUSTOM_SETTINGS if you don't want your implementation ties to http protocol.

DEFAULT_RESPONSE

public static final ClickHouseHttpOption DEFAULT_RESPONSE

Default server response.

KEEP_ALIVE

public static final ClickHouseHttpOption KEEP_ALIVE

Whether to enable keep-alive or not.

MAX_OPEN_CONNECTIONS

public static final ClickHouseHttpOption MAX_OPEN_CONNECTIONS

Max open connections apply with Apache HttpClient only.

RECEIVE_QUERY_PROGRESS

public static final ClickHouseHttpOption RECEIVE_QUERY_PROGRESS

Whether to receive information about the progress of a query in response headers.

SEND_HTTP_CLIENT_ID

public static final ClickHouseHttpOption SEND_HTTP_CLIENT_ID

Indicates whether http client would send its identification through Referer header to server. Valid values: 1. empty string - nothing is sent 2. IP_ADDRESS - client's IP address is used 3. HOST_NAME - host name is used

REMEMBER_LAST_SET_ROLES

public static final ClickHouseHttpOption REMEMBER_LAST_SET_ROLES

Whether to remember last set role and send them in every next requests as query parameters. Only one role can be set at a time.

Method Details

values

public static ClickHouseHttpOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClickHouseHttpOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultValue

public Serializable getDefaultValue()

Specified by:

getDefaultValue in interface com.clickhouse.config.ClickHouseOption

getDescription

public String getDescription()

Specified by:

getDescription in interface com.clickhouse.config.ClickHouseOption

getKey

public String getKey()

Specified by:

getKey in interface com.clickhouse.config.ClickHouseOption

getValueType

public Class<? extends Serializable> getValueType()

Specified by:

getValueType in interface com.clickhouse.config.ClickHouseOption

isSensitive

public boolean isSensitive()

Specified by:

isSensitive in interface com.clickhouse.config.ClickHouseOption