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 aformat
and 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
Format
for more details.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FormatDescriptor.Builder
Builder forFormatDescriptor
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
static FormatDescriptor.Builder
forFormat(String format)
Creates a newFormatDescriptor.Builder
describing a format with the given format identifier.String
getFormat()
Map<String,String>
getOptions()
int
hashCode()
String
toString()
-
-
-
Method Detail
-
forFormat
public static FormatDescriptor.Builder forFormat(String format)
Creates a newFormatDescriptor.Builder
describing a format with the given format identifier.- Parameters:
format
- The factory identifier for the format.
-
getFormat
public String getFormat()
-
-