org.apache.flink.table.functions

类 FunctionContext

java.lang.Object

org.apache.flink.table.functions.FunctionContext

@PublicEvolving
public class FunctionContext
extends Object

A FunctionContext allows to obtain global runtime information about the context in which the user-defined function is executed.

The information includes the metric group, distributed cache files, and global job parameters.

构造器概要

构造器

构造器和说明
FunctionContext(org.apache.flink.api.common.functions.RuntimeContext context) Wraps the underlying RuntimeContext.

方法概要

限定符和类型	方法和说明
File	getCachedFile(String name) Gets the local temporary file copy of a distributed cache files.
Set<org.apache.flink.api.common.externalresource.ExternalResourceInfo>	getExternalResourceInfos(String resourceName) Get the external resource information.
String	getJobParameter(String key, String defaultValue) Gets the global job parameter value associated with the given key as a string.
org.apache.flink.metrics.MetricGroup	getMetricGroup() Returns the metric group for this parallel subtask.

从类继承的方法 java.lang.Object

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

构造器详细资料

FunctionContext

public FunctionContext(org.apache.flink.api.common.functions.RuntimeContext context)

Wraps the underlying RuntimeContext.

参数:

context - the runtime context in which Flink's Function is executed.

方法详细资料

getMetricGroup

public org.apache.flink.metrics.MetricGroup getMetricGroup()

Returns the metric group for this parallel subtask.

返回:

metric group for this parallel subtask.

getCachedFile

public File getCachedFile(String name)

Gets the local temporary file copy of a distributed cache files.

参数:

name - distributed cache file name

返回:

local temporary file copy of a distributed cache file.

getJobParameter

public String getJobParameter(String key,
                              String defaultValue)

Gets the global job parameter value associated with the given key as a string.

参数:

key - key pointing to the associated value

defaultValue - default value which is returned in case global job parameter is null or there is no value associated with the given key

返回:

(default) value associated with the given key

getExternalResourceInfos

public Set<org.apache.flink.api.common.externalresource.ExternalResourceInfo> getExternalResourceInfos(String resourceName)

Get the external resource information.