Package org.apache.flink.table.api

Class ModelDescriptor

java.lang.Object

org.apache.flink.table.api.ModelDescriptor

@PublicEvolving
public class ModelDescriptor
extends Object

Describes a CatalogModel representing a model.

A ModelDescriptor is a template for creating a CatalogModel instance. It closely resembles the "CREATE MODEL" SQL DDL statement, containing input schema, output schema, and other characteristics.

This can be used to register a Model in the Table API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelDescriptor.Builder	Builder for ModelDescriptor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModelDescriptor(org.apache.flink.table.api.Schema inputSchema, org.apache.flink.table.api.Schema outputSchema, Map<String,String> modelOptions, String comment)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ModelDescriptor.Builder	forProvider(String provider)	Creates a new ModelDescriptor.Builder for the model with the given provider option.
int	hashCode()
ModelDescriptor.Builder	toBuilder()	Converts this immutable instance into a mutable ModelDescriptor.Builder.
org.apache.flink.table.catalog.CatalogModel	toCatalogModel()	Converts this descriptor into a CatalogModel.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelDescriptor

protected ModelDescriptor(@Nullable
                          org.apache.flink.table.api.Schema inputSchema,
                          @Nullable
                          org.apache.flink.table.api.Schema outputSchema,
                          Map<String,String> modelOptions,
                          @Nullable
                          String comment)

Method Detail

toCatalogModel

public org.apache.flink.table.catalog.CatalogModel toCatalogModel()

Converts this descriptor into a CatalogModel.

toBuilder

public ModelDescriptor.Builder toBuilder()

Converts this immutable instance into a mutable ModelDescriptor.Builder.

forProvider

public static ModelDescriptor.Builder forProvider(String provider)

Creates a new ModelDescriptor.Builder for the model with the given provider option.

Parameters:

provider - string value of provider for the model.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object