com.databricks.sdk.service.catalog.ConnectionsService Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.catalog;
import com.databricks.sdk.support.Generated;
/**
* Connections allow for creating a connection to an external data source.
*
* A connection is an abstraction of an external data source that can be connected from
* Databricks Compute. Creating a connection object is the first step to managing external data
* sources within Unity Catalog, with the second step being creating a data object (catalog, schema,
* or table) using the connection. Data objects derived from a connection can be written to or read
* from similar to other Unity Catalog data objects based on cloud storage. Users may create
* different types of connections with each connection having a unique set of configuration options
* to support credential management and other settings.
*
*
This is the high-level interface, that contains generated methods.
*
*
Evolving: this interface is under development. Method signatures may change.
*/
@Generated
public interface ConnectionsService {
/**
* Create a connection.
*
*
Creates a new connection
*
*
Creates a new connection to an external data source. It allows users to specify connection
* details and configurations for interaction with the external server.
*/
ConnectionInfo create(CreateConnection createConnection);
/**
* Delete a connection.
*
*
Deletes the connection that matches the supplied name.
*/
void delete(DeleteConnectionRequest deleteConnectionRequest);
/**
* Get a connection.
*
*
Gets a connection from it's name.
*/
ConnectionInfo get(GetConnectionRequest getConnectionRequest);
/**
* List connections.
*
*
List all connections.
*/
ListConnectionsResponse list(ListConnectionsRequest listConnectionsRequest);
/**
* Update a connection.
*
*
Updates the connection that matches the supplied name.
*/
ConnectionInfo update(UpdateConnection updateConnection);
}