Package org.apache.flink.python

Class PythonOptions

java.lang.Object

org.apache.flink.python.PythonOptions

@PublicEvolving
public class PythonOptions
extends Object

Configuration options for the Python API.

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigOption<Integer>	MAP_STATE_ITERATE_RESPONSE_BATCH_SIZE	The maximum number of entries sent to Python UDF worker per request when iterating a Python MapState.
static ConfigOption<Integer>	MAP_STATE_READ_CACHE_SIZE	The maximum number of cached items which read from Java side in a Python MapState.
static ConfigOption<Integer>	MAP_STATE_WRITE_CACHE_SIZE	The maximum number of write requests cached in a Python MapState.
static ConfigOption<Integer>	MAX_ARROW_BATCH_SIZE	The maximum number of elements to include in an arrow batch.
static ConfigOption<Integer>	MAX_BUNDLE_SIZE	The maximum number of elements to include in a bundle.
static ConfigOption<Long>	MAX_BUNDLE_TIME_MILLS	The maximum time to wait before finalising a bundle (in milliseconds).
static ConfigOption<String>	PYTHON_ARCHIVES
static ConfigOption<Map<String,String>>	PYTHON_ARCHIVES_DISTRIBUTED_CACHE_INFO
static ConfigOption<String>	PYTHON_CLIENT_EXECUTABLE
static ConfigOption<String>	PYTHON_EXECUTABLE
static ConfigOption<String>	PYTHON_EXECUTION_MODE	Specify the python runtime execution mode.
static ConfigOption<String>	PYTHON_FILES
static ConfigOption<Map<String,String>>	PYTHON_FILES_DISTRIBUTED_CACHE_INFO
static ConfigOption<Map<String,String>>	PYTHON_JOB_OPTIONS
static ConfigOption<String>	PYTHON_LOOPBACK_SERVER_ADDRESS
static ConfigOption<Boolean>	PYTHON_METRIC_ENABLED	The configuration to enable or disable metric for Python execution.
static ConfigOption<Boolean>	PYTHON_OPERATOR_CHAINING_ENABLED	The configuration to enable or disable python operator chaining.
static ConfigOption<String>	PYTHON_PATH	The configuration allows user to define python path for client and workers.
static ConfigOption<Boolean>	PYTHON_PROFILE_ENABLED	The configuration to enable or disable profile for Python execution.
static ConfigOption<String>	PYTHON_REQUIREMENTS
static ConfigOption<Map<String,String>>	PYTHON_REQUIREMENTS_FILE_DISTRIBUTED_CACHE_INFO
static ConfigOption<Boolean>	PYTHON_SYSTEMENV_ENABLED	The configuration to enable or disable system env for Python execution.
static ConfigOption<Integer>	STATE_CACHE_SIZE	The maximum number of states cached in a Python UDF worker.
static ConfigOption<Boolean>	USE_MANAGED_MEMORY	Whether the memory used by the Python framework is managed memory.

Constructor Summary

Constructors

Constructor	Description
PythonOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BUNDLE_SIZE

public static final ConfigOption<Integer> MAX_BUNDLE_SIZE

The maximum number of elements to include in a bundle.

MAX_BUNDLE_TIME_MILLS

public static final ConfigOption<Long> MAX_BUNDLE_TIME_MILLS

The maximum time to wait before finalising a bundle (in milliseconds).

MAX_ARROW_BATCH_SIZE

public static final ConfigOption<Integer> MAX_ARROW_BATCH_SIZE

The maximum number of elements to include in an arrow batch.

PYTHON_METRIC_ENABLED

public static final ConfigOption<Boolean> PYTHON_METRIC_ENABLED

The configuration to enable or disable metric for Python execution.

PYTHON_PROFILE_ENABLED

public static final ConfigOption<Boolean> PYTHON_PROFILE_ENABLED

The configuration to enable or disable profile for Python execution.

PYTHON_SYSTEMENV_ENABLED

public static final ConfigOption<Boolean> PYTHON_SYSTEMENV_ENABLED

The configuration to enable or disable system env for Python execution.

PYTHON_OPERATOR_CHAINING_ENABLED

public static final ConfigOption<Boolean> PYTHON_OPERATOR_CHAINING_ENABLED

The configuration to enable or disable python operator chaining.

PYTHON_FILES

public static final ConfigOption<String> PYTHON_FILES

PYTHON_REQUIREMENTS

public static final ConfigOption<String> PYTHON_REQUIREMENTS

PYTHON_PATH

public static final ConfigOption<String> PYTHON_PATH

The configuration allows user to define python path for client and workers.

PYTHON_ARCHIVES

public static final ConfigOption<String> PYTHON_ARCHIVES

PYTHON_EXECUTABLE

public static final ConfigOption<String> PYTHON_EXECUTABLE

PYTHON_CLIENT_EXECUTABLE

public static final ConfigOption<String> PYTHON_CLIENT_EXECUTABLE

USE_MANAGED_MEMORY

public static final ConfigOption<Boolean> USE_MANAGED_MEMORY

Whether the memory used by the Python framework is managed memory.

STATE_CACHE_SIZE

@Experimental
public static final ConfigOption<Integer> STATE_CACHE_SIZE

The maximum number of states cached in a Python UDF worker.

MAP_STATE_READ_CACHE_SIZE

@Experimental
public static final ConfigOption<Integer> MAP_STATE_READ_CACHE_SIZE

The maximum number of cached items which read from Java side in a Python MapState.

MAP_STATE_WRITE_CACHE_SIZE

@Experimental
public static final ConfigOption<Integer> MAP_STATE_WRITE_CACHE_SIZE

The maximum number of write requests cached in a Python MapState.

MAP_STATE_ITERATE_RESPONSE_BATCH_SIZE

@Experimental
public static final ConfigOption<Integer> MAP_STATE_ITERATE_RESPONSE_BATCH_SIZE

The maximum number of entries sent to Python UDF worker per request when iterating a Python MapState.

PYTHON_EXECUTION_MODE

@Experimental
public static final ConfigOption<String> PYTHON_EXECUTION_MODE

Specify the python runtime execution mode.

PYTHON_JOB_OPTIONS

public static final ConfigOption<Map<String,String>> PYTHON_JOB_OPTIONS

PYTHON_FILES_DISTRIBUTED_CACHE_INFO

public static final ConfigOption<Map<String,String>> PYTHON_FILES_DISTRIBUTED_CACHE_INFO

PYTHON_REQUIREMENTS_FILE_DISTRIBUTED_CACHE_INFO

public static final ConfigOption<Map<String,String>> PYTHON_REQUIREMENTS_FILE_DISTRIBUTED_CACHE_INFO

PYTHON_ARCHIVES_DISTRIBUTED_CACHE_INFO

public static final ConfigOption<Map<String,String>> PYTHON_ARCHIVES_DISTRIBUTED_CACHE_INFO

PYTHON_LOOPBACK_SERVER_ADDRESS

public static final ConfigOption<String> PYTHON_LOOPBACK_SERVER_ADDRESS

Constructor Detail

PythonOptions

public PythonOptions()