Package io.unitycatalog.client.api

Class TablesApi

java.lang.Object

io.unitycatalog.client.api.TablesApi

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

Constructor Summary

Constructors

Constructor	Description
TablesApi()
TablesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
TableInfo	createTable(CreateTable createTable)	Create a table.
ApiResponse<TableInfo>	createTableWithHttpInfo(CreateTable createTable)	Create a table.
Object	deleteTable(String fullName)	Delete a table Deletes a table from the specified parent catalog and schema.
ApiResponse<Object>	deleteTableWithHttpInfo(String fullName)	Delete a table Deletes a table from the specified parent catalog and schema.
protected ApiException	getApiException(String operationId, HttpResponse<InputStream> response)
TableInfo	getTable(String fullName)	Get a table Gets a table for a specific catalog and schema.
ApiResponse<TableInfo>	getTableWithHttpInfo(String fullName)	Get a table Gets a table for a specific catalog and schema.
ListTablesResponse	listTables(String catalogName, String schemaName, Integer maxResults, String pageToken)	List tables Gets the list of all available tables under the parent catalog and schema.
ApiResponse<ListTablesResponse>	listTablesWithHttpInfo(String catalogName, String schemaName, Integer maxResults, String pageToken)	List tables Gets the list of all available tables under the parent catalog and schema.

Methods inherited from class java.lang.Object

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

Constructor Details

TablesApi

public TablesApi()

TablesApi

public TablesApi(ApiClient apiClient)

Method Details

getApiException

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

Throws:

IOException

createTable

public TableInfo createTable(CreateTable createTable)
                      throws ApiException

Create a table. Only external table creation is supported. WARNING: This API is experimental and will change in future versions. Creates a new external table instance. WARNING: This API is experimental and will change in future versions.

Parameters:

createTable - (optional)

Returns:

TableInfo

Throws:

ApiException - if fails to make API call

createTableWithHttpInfo

public ApiResponse<TableInfo> createTableWithHttpInfo(CreateTable createTable)
                                               throws ApiException

Create a table. Only external table creation is supported. WARNING: This API is experimental and will change in future versions. Creates a new external table instance. WARNING: This API is experimental and will change in future versions.

Parameters:

createTable - (optional)

Returns:

ApiResponse<TableInfo>

Throws:

ApiException - if fails to make API call

deleteTable

public Object deleteTable(String fullName)
                   throws ApiException

Delete a table Deletes a table from the specified parent catalog and schema.

Parameters:

fullName - Full name of the table. (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

deleteTableWithHttpInfo

public ApiResponse<Object> deleteTableWithHttpInfo(String fullName)
                                            throws ApiException

Delete a table Deletes a table from the specified parent catalog and schema.

Parameters:

fullName - Full name of the table. (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

getTable

public TableInfo getTable(String fullName)
                   throws ApiException

Get a table Gets a table for a specific catalog and schema.

Parameters:

fullName - Full name of the table. (required)

Returns:

TableInfo

Throws:

ApiException - if fails to make API call

getTableWithHttpInfo

public ApiResponse<TableInfo> getTableWithHttpInfo(String fullName)
                                            throws ApiException

Get a table Gets a table for a specific catalog and schema.

Parameters:

fullName - Full name of the table. (required)

Returns:

ApiResponse<TableInfo>

Throws:

ApiException - if fails to make API call

listTables

public ListTablesResponse listTables(String catalogName,
 String schemaName,
 Integer maxResults,
 String pageToken)
                              throws ApiException

List tables Gets the list of all available tables under the 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 tables of interest. (required)

schemaName - Parent schema of tables. (required)

maxResults - Maximum number of tables 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 token to send for the next page of results (pagination). (optional)

Returns:

ListTablesResponse

Throws:

ApiException - if fails to make API call

listTablesWithHttpInfo

public ApiResponse<ListTablesResponse> listTablesWithHttpInfo(String catalogName,
 String schemaName,
 Integer maxResults,
 String pageToken)
                                                       throws ApiException

List tables Gets the list of all available tables under the 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 tables of interest. (required)

schemaName - Parent schema of tables. (required)

maxResults - Maximum number of tables 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 token to send for the next page of results (pagination). (optional)

Returns:

ApiResponse<ListTablesResponse>

Throws:

ApiException - if fails to make API call