org.apache.flink.table.descriptors

Class ConnectorDescriptor

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

org.apache.flink.table.descriptors.ConnectorDescriptor

All Implemented Interfaces:

Descriptor

Direct Known Subclasses:

CustomConnectorDescriptor, Elasticsearch, FileSystem, HBase, Kafka

@PublicEvolving
public abstract class ConnectorDescriptor
extends DescriptorBase
implements Descriptor

Describes a connector to an other system.

Constructor Summary

Constructors

Constructor and Description
ConnectorDescriptor(String type, int version, boolean formatNeeded) Constructs a ConnectorDescriptor.

Method Summary

Modifier and Type	Method and Description
protected boolean	isFormatNeeded() Returns if this connector requires a format descriptor.
protected abstract Map<String,String>	toConnectorProperties() Converts this descriptor into a set of connector properties.
Map<String,String>	toProperties() Converts this descriptor into a set of properties.

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

ConnectorDescriptor

public ConnectorDescriptor(String type,
                           int version,
                           boolean formatNeeded)

Constructs a ConnectorDescriptor.

Parameters:

type - string that identifies this connector

version - property version for backwards compatibility

formatNeeded - flag for basic validation of a needed format descriptor

Method Detail

toProperties

public final Map<String,String> toProperties()

Description copied from interface: Descriptor

Converts this descriptor into a set of properties.

Specified by:

toProperties in interface Descriptor

isFormatNeeded

protected final boolean isFormatNeeded()

Returns if this connector requires a format descriptor.

toConnectorProperties

protected abstract Map<String,String> toConnectorProperties()

Converts this descriptor into a set of connector properties. Usually prefixed with ConnectorDescriptorValidator.CONNECTOR.