CatalogModel (Flink : Table : Common 2.1.0 API)

All Known Subinterfaces:

ResolvedCatalogModel

All Known Implementing Classes:

DefaultCatalogModel, DefaultResolvedCatalogModel
```
@PublicEvolving
public interface CatalogModel
```
Interface for a model in a catalog.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CatalogModel`	`copy()`	Get a deep copy of the CatalogModel instance.
`CatalogModel`	`copy(Map<String,String> options)`	Copy the input model options into the CatalogModel instance.
`String`	`getComment()`	Get comment of the model.
`Schema`	`getInputSchema()`	Get the unresolved input schema of the model.
`Map<String,String>`	`getOptions()`	Returns a map of string-based model options.
`Schema`	`getOutputSchema()`	Get the unresolved output schema of the model.
`static CatalogModel`	`of(Schema inputSchema, Schema outputSchema, Map<String,String> modelOptions, String comment)`	Creates a basic implementation of this interface.

- Method Detail
  - getOptions
```
Map<String,String> getOptions()
```
    Returns a map of string-based model options.
  - getInputSchema
```
Schema getInputSchema()
```
    Get the unresolved input schema of the model.
    
    Returns:
    
    unresolved input schema of the model.
  - getOutputSchema
```
Schema getOutputSchema()
```
    Get the unresolved output schema of the model.
    
    Returns:
    
    unresolved output schema of the model.
  - getComment
```
String getComment()
```
    Get comment of the model.
    
    Returns:
    
    comment of the model.
  - copy
```
CatalogModel copy()
```
    Get a deep copy of the CatalogModel instance.
    
    Returns:
    
    a copy of the CatalogModel instance
  - copy
```
CatalogModel copy(Map<String,String> options)
```
    Copy the input model options into the CatalogModel instance.
    
    Returns:
    
    a copy of the CatalogModel instance with new model options.
  - of
```
static CatalogModel of(Schema inputSchema,
                       Schema outputSchema,
                       Map<String,String> modelOptions,
                       @Nullable
                       String comment)
```
    Creates a basic implementation of this interface.
    
    Parameters:
    
    inputSchema - unresolved input schema
    
    outputSchema - unresolved output schema
    
    modelOptions - model options
    
    comment - optional comment