Package org.apache.flink.table.api

Class FunctionDescriptor

java.lang.Object

org.apache.flink.table.api.FunctionDescriptor

@PublicEvolving
public class FunctionDescriptor
extends Object

Describes a CatalogFunction.

A FunctionDescriptor is a template for creating a CatalogFunction instance. It closely resembles the "CREATE FUNCTION" SQL DDL statement.

This can be used to register a table in the Table API, see TableEnvironment.createFunction(String, FunctionDescriptor).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionDescriptor.Builder	Builder for FunctionDescriptor.

Method Summary

Modifier and Type	Method	Description
static FunctionDescriptor.Builder	forClassName(String className)	Creates a FunctionDescriptor.Builder for a function descriptor with the given class name.
static FunctionDescriptor.Builder	forFunctionClass(Class<? extends org.apache.flink.table.functions.UserDefinedFunction> functionClass)	Creates a FunctionDescriptor.Builder for a function descriptor for the given function class.
String	getClassName()
org.apache.flink.table.catalog.FunctionLanguage	getLanguage()
Map<String,String>	getOptions()
List<org.apache.flink.table.resource.ResourceUri>	getResourceUris()

Methods inherited from class java.lang.Object

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

Method Detail

forClassName

public static FunctionDescriptor.Builder forClassName(String className)

Creates a FunctionDescriptor.Builder for a function descriptor with the given class name.

forFunctionClass

public static FunctionDescriptor.Builder forFunctionClass(Class<? extends org.apache.flink.table.functions.UserDefinedFunction> functionClass)

Creates a FunctionDescriptor.Builder for a function descriptor for the given function class.

getClassName

public String getClassName()

getLanguage

public org.apache.flink.table.catalog.FunctionLanguage getLanguage()

getResourceUris

public List<org.apache.flink.table.resource.ResourceUri> getResourceUris()

getOptions

public Map<String,String> getOptions()