org.apache.flink.configuration

Class QueryableStateOptions

java.lang.Object

org.apache.flink.configuration.QueryableStateOptions

@PublicEvolving
public class QueryableStateOptions
extends Object

The set of configuration options relating to Queryable State.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<Integer>	CLIENT_NETWORK_THREADS Number of network (event loop) threads for the KvState client (0 => Use number of available cores).
static ConfigOption<Boolean>	ENABLE_QUERYABLE_STATE_PROXY_SERVER Option whether the queryable state proxy and server should be enabled where possible and configurable.
static ConfigOption<Integer>	PROXY_ASYNC_QUERY_THREADS Number of async query threads for the client proxy (0 => #slots).
static ConfigOption<Integer>	PROXY_NETWORK_THREADS Number of network (event loop) threads for the client proxy (0 => #slots).
static ConfigOption<String>	PROXY_PORT_RANGE The config parameter defining the server port range of the queryable state proxy.
static ConfigOption<Integer>	SERVER_ASYNC_QUERY_THREADS Number of async query threads for the KvStateServerHandler (0 => #slots).
static ConfigOption<Integer>	SERVER_NETWORK_THREADS Number of network (event loop) threads for the KvState server (0 => #slots).
static ConfigOption<String>	SERVER_PORT_RANGE The config parameter defining the server port range of the queryable state server.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PROXY_PORT_RANGE

public static final ConfigOption<String> PROXY_PORT_RANGE

The config parameter defining the server port range of the queryable state proxy.

A proxy runs on each Task Manager, so many proxies may run on the same machine.

Given this, and to avoid port clashes, the user can specify a port range and the proxy will bind to the first free port in that range.

The specified range can be:

1. a port: "9123",
2. a range of ports: "50100-50200", or
3. a list of ranges and ports: "50100-50200,50300-50400,51234"

The default port is 9069.

PROXY_NETWORK_THREADS

public static final ConfigOption<Integer> PROXY_NETWORK_THREADS

Number of network (event loop) threads for the client proxy (0 => #slots).

PROXY_ASYNC_QUERY_THREADS

public static final ConfigOption<Integer> PROXY_ASYNC_QUERY_THREADS

Number of async query threads for the client proxy (0 => #slots).

SERVER_PORT_RANGE

public static final ConfigOption<String> SERVER_PORT_RANGE

The config parameter defining the server port range of the queryable state server.

A state server runs on each Task Manager, so many server may run on the same machine.

Given this, and to avoid port clashes, the user can specify a port range and the server will bind to the first free port in that range.

The specified range can be:

1. a port: "9123",
2. a range of ports: "50100-50200", or
3. a list of ranges and ports: "50100-50200,50300-50400,51234"

The default port is 9067.

SERVER_NETWORK_THREADS

public static final ConfigOption<Integer> SERVER_NETWORK_THREADS

Number of network (event loop) threads for the KvState server (0 => #slots).

SERVER_ASYNC_QUERY_THREADS

public static final ConfigOption<Integer> SERVER_ASYNC_QUERY_THREADS

Number of async query threads for the KvStateServerHandler (0 => #slots).

ENABLE_QUERYABLE_STATE_PROXY_SERVER

public static final ConfigOption<Boolean> ENABLE_QUERYABLE_STATE_PROXY_SERVER

Option whether the queryable state proxy and server should be enabled where possible and configurable.

Queryable state proxy and server are still more experimental features, hence disabled unless they are enable in user configuration.

CLIENT_NETWORK_THREADS

public static final ConfigOption<Integer> CLIENT_NETWORK_THREADS

Number of network (event loop) threads for the KvState client (0 => Use number of available cores).