Package org.apache.flink.table.api
Class FormatDescriptor
- java.lang.Object
-
- org.apache.flink.table.api.FormatDescriptor
-
@PublicEvolving public final class FormatDescriptor extends Object
Describes aformatand its options for use withTableDescriptor.Formats are responsible for encoding and decoding data in table connectors. Note that not every connector has a format, while others may have multiple formats (e.g. the Kafka connector has separate formats for keys and values). Common formats are "json", "csv", "avro", etc. See
Formatfor more details.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFormatDescriptor.BuilderBuilder forFormatDescriptor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)static FormatDescriptor.BuilderforFormat(String format)Creates a newFormatDescriptor.Builderdescribing a format with the given format identifier.StringgetFormat()Map<String,String>getOptions()inthashCode()StringtoString()
-
-
-
Method Detail
-
forFormat
public static FormatDescriptor.Builder forFormat(String format)
Creates a newFormatDescriptor.Builderdescribing a format with the given format identifier.- Parameters:
format- The factory identifier for the format.
-
getFormat
public String getFormat()
-
-