Package io.unitycatalog.client.api

Class FunctionsApi

java.lang.Object

io.unitycatalog.client.api.FunctionsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.5.0")
public class FunctionsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
FunctionsApi()
FunctionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
FunctionInfo	createFunction(CreateFunctionRequest createFunctionRequest)	Create a function.
ApiResponse<FunctionInfo>	createFunctionWithHttpInfo(CreateFunctionRequest createFunctionRequest)	Create a function.
Object	deleteFunction(String name)	Delete a function Deletes the function that matches the supplied name.
ApiResponse<Object>	deleteFunctionWithHttpInfo(String name)	Delete a function Deletes the function that matches the supplied name.
protected ApiException	getApiException(String operationId, HttpResponse<InputStream> response)
FunctionInfo	getFunction(String name)	Get a function Gets a function from within a parent catalog and schema.
ApiResponse<FunctionInfo>	getFunctionWithHttpInfo(String name)	Get a function Gets a function from within a parent catalog and schema.
ListFunctionsResponse	listFunctions(String catalogName, String schemaName, Integer maxResults, String pageToken)	List functions List functions within the specified parent catalog and schema.
ApiResponse<ListFunctionsResponse>	listFunctionsWithHttpInfo(String catalogName, String schemaName, Integer maxResults, String pageToken)	List functions List functions within the specified parent catalog and schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FunctionsApi

public FunctionsApi()

FunctionsApi

public FunctionsApi(ApiClient apiClient)

Method Details

getApiException

protected ApiException getApiException(String operationId,
 HttpResponse<InputStream> response)
                                throws IOException

Throws:

IOException

createFunction

public FunctionInfo createFunction(CreateFunctionRequest createFunctionRequest)
                            throws ApiException

Create a function. WARNING: This API is experimental and will change in future versions. Creates a new function instance. WARNING: This API is experimental and will change in future versions.

Parameters:

createFunctionRequest - (optional)

Returns:

FunctionInfo

Throws:

ApiException - if fails to make API call

createFunctionWithHttpInfo

public ApiResponse<FunctionInfo> createFunctionWithHttpInfo(CreateFunctionRequest createFunctionRequest)
                                                     throws ApiException

Create a function. WARNING: This API is experimental and will change in future versions. Creates a new function instance. WARNING: This API is experimental and will change in future versions.

Parameters:

createFunctionRequest - (optional)

Returns:

ApiResponse<FunctionInfo>

Throws:

ApiException - if fails to make API call

deleteFunction

public Object deleteFunction(String name)
                      throws ApiException

Delete a function Deletes the function that matches the supplied name.

Parameters:

name - The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

deleteFunctionWithHttpInfo

public ApiResponse<Object> deleteFunctionWithHttpInfo(String name)
                                               throws ApiException

Delete a function Deletes the function that matches the supplied name.

Parameters:

name - The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

getFunction

public FunctionInfo getFunction(String name)
                         throws ApiException

Get a function Gets a function from within a parent catalog and schema.

Parameters:

name - The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). (required)

Returns:

FunctionInfo

Throws:

ApiException - if fails to make API call

getFunctionWithHttpInfo

public ApiResponse<FunctionInfo> getFunctionWithHttpInfo(String name)
                                                  throws ApiException

Get a function Gets a function from within a parent catalog and schema.

Parameters:

name - The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). (required)

Returns:

ApiResponse<FunctionInfo>

Throws:

ApiException - if fails to make API call

listFunctions

public ListFunctionsResponse listFunctions(String catalogName,
 String schemaName,
 Integer maxResults,
 String pageToken)
                                    throws ApiException

List functions List functions within the specified parent catalog and schema. There is no guarantee of a specific ordering of the elements in the array.

Parameters:

catalogName - Name of parent catalog for functions of interest. (required)

schemaName - Parent schema of functions. (required)

maxResults - Maximum number of functions to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; (optional)

pageToken - Opaque pagination token to go to next page based on previous query. (optional)

Returns:

ListFunctionsResponse

Throws:

ApiException - if fails to make API call

listFunctionsWithHttpInfo

public ApiResponse<ListFunctionsResponse> listFunctionsWithHttpInfo(String catalogName,
 String schemaName,
 Integer maxResults,
 String pageToken)
                                                             throws ApiException

List functions List functions within the specified parent catalog and schema. There is no guarantee of a specific ordering of the elements in the array.

Parameters:

catalogName - Name of parent catalog for functions of interest. (required)

schemaName - Parent schema of functions. (required)

maxResults - Maximum number of functions to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; (optional)

pageToken - Opaque pagination token to go to next page based on previous query. (optional)

Returns:

ApiResponse<ListFunctionsResponse>

Throws:

ApiException - if fails to make API call