org.apache.flink.configuration

Class RestOptions

java.lang.Object

org.apache.flink.configuration.RestOptions

@Internal
public class RestOptions
extends Object

Configuration parameters for REST communication.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<String>	ADDRESS The address that should be used by clients to connect to the server.
static ConfigOption<Duration>	ASYNC_OPERATION_STORE_DURATION
static ConfigOption<Long>	AWAIT_LEADER_TIMEOUT The time in ms that the client waits for the leader address, e.g., Dispatcher or WebMonitorEndpoint.
static ConfigOption<String>	BIND_ADDRESS The address that the server binds itself to.
static ConfigOption<String>	BIND_PORT The port range that the server could bind itself to.
static ConfigOption<Integer>	CACHE_CHECKPOINT_STATISTICS_SIZE Maximum number of entries in the checkpoint statistics cache.
static ConfigOption<Duration>	CACHE_CHECKPOINT_STATISTICS_TIMEOUT Duration from write, after which cached checkpoints statistics are cleaned up.
static ConfigOption<Integer>	CLIENT_MAX_CONTENT_LENGTH The maximum content length that the client will handle.
static ConfigOption<Long>	CONNECTION_TIMEOUT The maximum time in ms for the client to establish a TCP connection.
static ConfigOption<Boolean>	ENABLE_FLAMEGRAPH Enables the experimental flame graph feature.
static ConfigOption<Duration>	FLAMEGRAPH_CLEANUP_INTERVAL "Time after which cached stats are cleaned up if not accessed.
static ConfigOption<Duration>	FLAMEGRAPH_DELAY Delay between individual stack trace samples taken for building a FlameGraph.
static ConfigOption<Integer>	FLAMEGRAPH_NUM_SAMPLES Number of samples to take to build a FlameGraph.
static ConfigOption<Duration>	FLAMEGRAPH_REFRESH_INTERVAL Time after which available stats are deprecated and need to be refreshed (by resampling).
static ConfigOption<Integer>	FLAMEGRAPH_STACK_TRACE_DEPTH Maximum depth of stack traces used to create FlameGraphs.
static ConfigOption<Long>	IDLENESS_TIMEOUT The maximum time in ms for a connection to stay idle before failing.
static ConfigOption<Integer>	PORT The port that the REST client connects to and the REST server binds to if BIND_PORT has not been specified.
static ConfigOption<Long>	RETRY_DELAY The time in ms that the client waits between retries.
static ConfigOption<Integer>	RETRY_MAX_ATTEMPTS The number of retries the client will attempt if a retryable operations fails.
static ConfigOption<Integer>	SERVER_MAX_CONTENT_LENGTH The maximum content length that the server will handle.
static ConfigOption<Integer>	SERVER_NUM_THREADS
static ConfigOption<Integer>	SERVER_THREAD_PRIORITY
static ConfigOption<String>	URL_PREFIX The url prefix that should be used by clients to construct the full target url.

Constructor Summary

Constructors

Constructor and Description
RestOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

BIND_ADDRESS

public static final ConfigOption<String> BIND_ADDRESS

The address that the server binds itself to.

BIND_PORT

public static final ConfigOption<String> BIND_PORT

The port range that the server could bind itself to.

URL_PREFIX

public static final ConfigOption<String> URL_PREFIX

The url prefix that should be used by clients to construct the full target url.

ADDRESS

public static final ConfigOption<String> ADDRESS

The address that should be used by clients to connect to the server.

PORT

public static final ConfigOption<Integer> PORT

The port that the REST client connects to and the REST server binds to if BIND_PORT has not been specified.

AWAIT_LEADER_TIMEOUT

public static final ConfigOption<Long> AWAIT_LEADER_TIMEOUT

The time in ms that the client waits for the leader address, e.g., Dispatcher or WebMonitorEndpoint.

RETRY_MAX_ATTEMPTS

public static final ConfigOption<Integer> RETRY_MAX_ATTEMPTS

The number of retries the client will attempt if a retryable operations fails.

See Also:

RETRY_DELAY

RETRY_DELAY

public static final ConfigOption<Long> RETRY_DELAY

The time in ms that the client waits between retries.

See Also:

RETRY_MAX_ATTEMPTS

CONNECTION_TIMEOUT

public static final ConfigOption<Long> CONNECTION_TIMEOUT

The maximum time in ms for the client to establish a TCP connection.

IDLENESS_TIMEOUT

public static final ConfigOption<Long> IDLENESS_TIMEOUT

The maximum time in ms for a connection to stay idle before failing.

SERVER_MAX_CONTENT_LENGTH

public static final ConfigOption<Integer> SERVER_MAX_CONTENT_LENGTH

The maximum content length that the server will handle.

CLIENT_MAX_CONTENT_LENGTH

public static final ConfigOption<Integer> CLIENT_MAX_CONTENT_LENGTH

The maximum content length that the client will handle.

SERVER_NUM_THREADS

public static final ConfigOption<Integer> SERVER_NUM_THREADS

SERVER_THREAD_PRIORITY

public static final ConfigOption<Integer> SERVER_THREAD_PRIORITY

CACHE_CHECKPOINT_STATISTICS_TIMEOUT

public static final ConfigOption<Duration> CACHE_CHECKPOINT_STATISTICS_TIMEOUT

Duration from write, after which cached checkpoints statistics are cleaned up.

CACHE_CHECKPOINT_STATISTICS_SIZE

public static final ConfigOption<Integer> CACHE_CHECKPOINT_STATISTICS_SIZE

Maximum number of entries in the checkpoint statistics cache.

ENABLE_FLAMEGRAPH

public static final ConfigOption<Boolean> ENABLE_FLAMEGRAPH

Enables the experimental flame graph feature.

FLAMEGRAPH_CLEANUP_INTERVAL

public static final ConfigOption<Duration> FLAMEGRAPH_CLEANUP_INTERVAL

"Time after which cached stats are cleaned up if not accessed. It can be specified using notation: "100 s", "10 m".

FLAMEGRAPH_REFRESH_INTERVAL

public static final ConfigOption<Duration> FLAMEGRAPH_REFRESH_INTERVAL

Time after which available stats are deprecated and need to be refreshed (by resampling). It can be specified using notation: "30 s", "1 m".

FLAMEGRAPH_NUM_SAMPLES

public static final ConfigOption<Integer> FLAMEGRAPH_NUM_SAMPLES

Number of samples to take to build a FlameGraph.

FLAMEGRAPH_DELAY

public static final ConfigOption<Duration> FLAMEGRAPH_DELAY

Delay between individual stack trace samples taken for building a FlameGraph. It can be specified using notation: "100 ms", "1 s".

FLAMEGRAPH_STACK_TRACE_DEPTH

public static final ConfigOption<Integer> FLAMEGRAPH_STACK_TRACE_DEPTH

Maximum depth of stack traces used to create FlameGraphs.

ASYNC_OPERATION_STORE_DURATION

public static final ConfigOption<Duration> ASYNC_OPERATION_STORE_DURATION

Constructor Detail

RestOptions

public RestOptions()