java.lang.Object
- org.apache.flink.table.functions.BuiltInFunctionDefinition.Builder

Enclosing class:

BuiltInFunctionDefinition
```
@Internal
public static final class BuiltInFunctionDefinition.Builder
extends Object
```
Builder for fluent definition of built-in functions.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BuiltInFunctionDefinition`	`build()`
`BuiltInFunctionDefinition.Builder`	`callSyntax(String name, SqlCallSyntax syntax)`	Overwrites the syntax used for unparsing a function into a SQL string.
`BuiltInFunctionDefinition.Builder`	`callSyntax(SqlCallSyntax syntax)`	Overwrites the syntax used for unparsing a function into a SQL string.
`BuiltInFunctionDefinition.Builder`	`inputTypeStrategy(InputTypeStrategy inputTypeStrategy)`
`BuiltInFunctionDefinition.Builder`	`internal()`	Specifies that this `BuiltInFunctionDefinition` is meant for internal purposes only and should not be exposed when listing functions.
`BuiltInFunctionDefinition.Builder`	`kind(FunctionKind kind)`
`BuiltInFunctionDefinition.Builder`	`name(String name)`	Specifies a name that uniquely identifies a built-in function.
`BuiltInFunctionDefinition.Builder`	`namedArguments(String... argumentNames)`
`BuiltInFunctionDefinition.Builder`	`notDeterministic()`
`BuiltInFunctionDefinition.Builder`	`outputTypeStrategy(TypeStrategy outputTypeStrategy)`
`BuiltInFunctionDefinition.Builder`	`runtimeClass(String runtimeClass)`	Specifies the runtime class implementing this `BuiltInFunctionDefinition`.
`BuiltInFunctionDefinition.Builder`	`runtimeDeferred()`	Specifies that this `BuiltInFunctionDefinition` will be mapped to a Calcite function.
`BuiltInFunctionDefinition.Builder`	`runtimeProvided()`	Specifies that this `BuiltInFunctionDefinition` is implemented during code generation.
`BuiltInFunctionDefinition.Builder`	`sqlName(String name)`	Overwrites the name that is used for unparsing a function into a SQL string.
`BuiltInFunctionDefinition.Builder`	`typedArguments(DataType... argumentTypes)`
`BuiltInFunctionDefinition.Builder`	`version(int version)`	Specifies a version that will be persisted in the plan together with the function's name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - name
```
public BuiltInFunctionDefinition.Builder name(String name)
```
    Specifies a name that uniquely identifies a built-in function.
    Please adhere to the following naming convention:
    
    Use upper case and separate words with underscore.
    Depending on the importance of the function, the underscore is sometimes omitted e.g. for IFNULL or TYPEOF but not for TO_TIMESTAMP_LTZ.
    Internal functions must start with $ and include a version starting from 1. The following format is enforced: $NAME$VERSION such as $REPLICATE_ROWS$1.
  - version
```
public BuiltInFunctionDefinition.Builder version(int version)
```
    Specifies a version that will be persisted in the plan together with the function's name. The default version is 1 for non-internal functions.
    Note: Internal functions don't need to specify a version as we enforce a unique name that includes a version (see name(String)).
  - kind
```
public BuiltInFunctionDefinition.Builder kind(FunctionKind kind)
```
  - namedArguments
```
public BuiltInFunctionDefinition.Builder namedArguments(String... argumentNames)
```
  - typedArguments
```
public BuiltInFunctionDefinition.Builder typedArguments(DataType... argumentTypes)
```
  - inputTypeStrategy
```
public BuiltInFunctionDefinition.Builder inputTypeStrategy(InputTypeStrategy inputTypeStrategy)
```
  - outputTypeStrategy
```
public BuiltInFunctionDefinition.Builder outputTypeStrategy(TypeStrategy outputTypeStrategy)
```
  - notDeterministic
```
public BuiltInFunctionDefinition.Builder notDeterministic()
```
  - runtimeProvided
```
public BuiltInFunctionDefinition.Builder runtimeProvided()
```
    Specifies that this BuiltInFunctionDefinition is implemented during code generation.
  - runtimeClass
```
public BuiltInFunctionDefinition.Builder runtimeClass(String runtimeClass)
```
    Specifies the runtime class implementing this BuiltInFunctionDefinition.
  - runtimeDeferred
```
public BuiltInFunctionDefinition.Builder runtimeDeferred()
```
    Specifies that this BuiltInFunctionDefinition will be mapped to a Calcite function.
  - internal
```
public BuiltInFunctionDefinition.Builder internal()
```
    Specifies that this BuiltInFunctionDefinition is meant for internal purposes only and should not be exposed when listing functions.
  - callSyntax
```
public BuiltInFunctionDefinition.Builder callSyntax(SqlCallSyntax syntax)
```
    Overwrites the syntax used for unparsing a function into a SQL string. If not specified, SqlCallSyntax.FUNCTION is used.
  - callSyntax
```
public BuiltInFunctionDefinition.Builder callSyntax(String name,
                                                    SqlCallSyntax syntax)
```
    Overwrites the syntax used for unparsing a function into a SQL string. If not specified, SqlCallSyntax.FUNCTION is used. This method overwrites the name as well. If the name is not provided name(String) is passed to the SqlCallSyntax.
  - sqlName
```
public BuiltInFunctionDefinition.Builder sqlName(String name)
```
    Overwrites the name that is used for unparsing a function into a SQL string. If not specified, name(String) is used.
  - build
```
public BuiltInFunctionDefinition build()
```

Class BuiltInFunctionDefinition.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

name

version

kind

namedArguments

typedArguments

inputTypeStrategy

outputTypeStrategy

notDeterministic

runtimeProvided

runtimeClass

runtimeDeferred

internal

callSyntax

callSyntax

sqlName

build