org.apache.flink.table.descriptors.python

Class CustomFormatDescriptor

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

org.apache.flink.table.descriptors.FormatDescriptor

org.apache.flink.table.descriptors.python.CustomFormatDescriptor

All Implemented Interfaces:

org.apache.flink.table.descriptors.Descriptor

@Internal
public class CustomFormatDescriptor
extends org.apache.flink.table.descriptors.FormatDescriptor

Describes the custom format of data.

Constructor Summary

Constructors

Constructor and Description
CustomFormatDescriptor(String type, int version) Constructs a CustomFormatDescriptor.

Method Summary

Modifier and Type	Method and Description
CustomFormatDescriptor	properties(Map<String,String> properties) Adds a set of properties for the format.
CustomFormatDescriptor	property(String key, String value) Adds a configuration property for the format.
protected Map<String,String>	toFormatProperties()

Methods inherited from class org.apache.flink.table.descriptors.FormatDescriptor

toProperties

Methods inherited from class org.apache.flink.table.descriptors.DescriptorBase

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFormatDescriptor

public CustomFormatDescriptor(String type,
                              int version)

Constructs a CustomFormatDescriptor.

Parameters:

type - String that identifies this format.

version - Property version for backwards compatibility.

Method Detail

property

public CustomFormatDescriptor property(String key,
                                       String value)

Adds a configuration property for the format.

Parameters:

key - The property key to be set.

value - The property value to be set.

properties

public CustomFormatDescriptor properties(Map<String,String> properties)

Adds a set of properties for the format.

Parameters:

properties - The properties to add.

toFormatProperties

protected Map<String,String> toFormatProperties()

Specified by:

toFormatProperties in class org.apache.flink.table.descriptors.FormatDescriptor