DescribeFunctionOperation (Flink : Table : API Java 2.0.0 API)

java.lang.Object
- org.apache.flink.table.operations.DescribeFunctionOperation

All Implemented Interfaces:: ExecutableOperation, Operation

@Internal
public class DescribeFunctionOperation
extends Object
implements Operation, ExecutableOperation

Operation to describe a FUNCTION.

Syntax:

 DESCRIBE FUNCTION [EXTENDED] [[catalogName.] dataBasesName].sqlIdentifier

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.flink.table.operations.ExecutableOperation
  ExecutableOperation.Context

Constructor Summary

Constructors
Constructor Description

DescribeFunctionOperation(org.apache.flink.table.catalog.UnresolvedIdentifier sqlIdentifier, boolean isExtended)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`asSummaryString()`	Returns a string that summarizes this operation for printing to a console.
`TableResultInternal`	`execute(ExecutableOperation.Context ctx)`	Executes the given operation and return the execution result.
`org.apache.flink.table.catalog.UnresolvedIdentifier`	`getSqlIdentifier()`
`boolean`	`isExtended()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DescribeFunctionOperation
```
public DescribeFunctionOperation(org.apache.flink.table.catalog.UnresolvedIdentifier sqlIdentifier,
                                 boolean isExtended)
```
- Method Detail
  - getSqlIdentifier
```
public org.apache.flink.table.catalog.UnresolvedIdentifier getSqlIdentifier()
```
  - isExtended
```
public boolean isExtended()
```
  - asSummaryString
```
public String asSummaryString()
```
    Description copied from interface: Operation
    
    Returns a string that summarizes this operation for printing to a console. An implementation might skip very specific properties.
    
    Specified by:
    
    asSummaryString in interface Operation
    
    Returns:
    
    summary string of this operation for debugging purposes
  - execute
```
public TableResultInternal execute(ExecutableOperation.Context ctx)
```
    Description copied from interface: ExecutableOperation
    
    Executes the given operation and return the execution result.
    
    Specified by:
    
    execute in interface ExecutableOperation
    
    Parameters:
    
    ctx - the context to execute the operation.
    
    Returns:
    
    the content of the execution result.
    
    See Also:
    
    TableEnvironmentInternal.executeInternal(Operation)