org.apache.flink.table.api

Class FormatDescriptor

java.lang.Object

org.apache.flink.table.api.FormatDescriptor

@PublicEvolving
public final class FormatDescriptor
extends Object

Describes a format and its options for use with TableDescriptor.

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 and Description
static class	FormatDescriptor.Builder Builder for FormatDescriptor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FormatDescriptor.Builder	forFormat(String format) Creates a new FormatDescriptor.Builder describing a format with the given format identifier.
String	getFormat()
Map<String,String>	getOptions()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

forFormat

public static FormatDescriptor.Builder forFormat(String format)

Creates a new FormatDescriptor.Builder describing a format with the given format identifier.

Parameters:

format - The factory identifier for the format.

getFormat

public String getFormat()

getOptions

public Map<String,String> getOptions()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object