Package org.apache.flink.table.api

Class FormatDescriptor.Builder

java.lang.Object

org.apache.flink.table.api.FormatDescriptor.Builder

Enclosing class:

FormatDescriptor

@PublicEvolving
public static class FormatDescriptor.Builder
extends Object

Builder for FormatDescriptor.

Method Summary

Modifier and Type	Method	Description
FormatDescriptor	build()	Returns an immutable instance of FormatDescriptor.
FormatDescriptor.Builder	option(String key, String value)	Sets the given option on the format.
<T> FormatDescriptor.Builder	option(org.apache.flink.configuration.ConfigOption<T> configOption, T value)	Sets the given option on the format.

Methods inherited from class java.lang.Object

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

Method Details

option

public <T> FormatDescriptor.Builder option(org.apache.flink.configuration.ConfigOption<T> configOption,
 T value)

Sets the given option on the format.

option

public FormatDescriptor.Builder option(String key,
 String value)

Sets the given option on the format.

Note that format options must not be prefixed with the format identifier itself here. For example,

 FormatDescriptor.forFormat("json")
   .option("ignore-parse-errors", "true")
   .build();
 

will automatically be converted into its prefixed form:

 'format' = 'json'
 'json.ignore-parse-errors' = 'true'
 

build

public FormatDescriptor build()

Returns an immutable instance of FormatDescriptor.