Struct ConnectionServiceClient

pub struct ConnectionServiceClient<T>(/* private fields */);

A Connection contains the relevant metadata and information to be used as a data source for runs. The Connection Service is responsible for creating, updating, and retrieving database connections.

Implementations

impl<T> ConnectionServiceClient<T>

where T: Client,

pub fn create_connection( &self, auth_: &BearerToken, create_connection: &CreateConnection, ) -> Result<Connection, Error>

Creates a new connection.

pub fn update_connection( &self, auth_: &BearerToken, rid: &ConnectionRid, request: &UpdateConnectionRequest, ) -> Result<Connection, Error>

Updates an existing connection.

pub fn update_connection_status( &self, auth_: &BearerToken, rid: &ConnectionRid, request: &ConnectionStatus, ) -> Result<(), Error>

Updates an existing connection status.

pub fn add_available_tags( &self, auth_: &BearerToken, rid: &ConnectionRid, tags: &BTreeMap<TagName, BTreeSet<TagValue>>, ) -> Result<Connection, Error>

Adds available tag key/value pairs to the connection. If a tag name already exists, the values will be merged.

pub fn get_connection( &self, auth_: &BearerToken, rid: &ConnectionRid, ) -> Result<Connection, Error>

Gets a connection by its RID.

pub fn get_connections( &self, auth_: &BearerToken, rids: &BTreeSet<ConnectionRid>, ) -> Result<BTreeSet<Connection>, Error>

Gets a set of connections by their RIDs.

pub fn list_connections( &self, auth_: &BearerToken, include_archived: Option<bool>, workspaces: &BTreeSet<WorkspaceRid>, ) -> Result<BTreeSet<Connection>, Error>

Lists all connections.

pub fn archive_connection( &self, auth_: &BearerToken, rid: &ConnectionRid, ) -> Result<(), Error>

Archives a connection, which simply tags the connection for a client to filter.

pub fn unarchive_connection( &self, auth_: &BearerToken, rid: &ConnectionRid, ) -> Result<(), Error>

Undoes the archiving of a connection.

Trait Implementations

impl<T: Clone> Clone for ConnectionServiceClient<T>

fn clone(&self) -> ConnectionServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for ConnectionServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Service<T> for ConnectionServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.