Struct Client 

pub struct Client { /* private fields */ }

Client for oversync API

HTTP API for managing oversync pipes, sinks, recipes, and sync status.

Version: 0.6.0

Implementations

impl Client

pub fn new(baseurl: &str) -> Self

Create a new client.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Construct a new client with an existing reqwest::Client, allowing more control over its configuration.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

impl Client

pub async fn export_config<'a>( &'a self, format: Option<ExportConfigFormat>, ) -> Result<ResponseValue<ExportConfigResponse>, Error<ErrorResponse>>

Sends a GET request to /config/export

Arguments:

• format: Export format: toml or json

pub async fn import_config<'a>( &'a self, body: &'a ImportConfigRequest, ) -> Result<ResponseValue<ImportConfigResponse>, Error<ErrorResponse>>

Sends a POST request to /config/import

pub async fn list_config_versions<'a>( &'a self, ) -> Result<ResponseValue<Vec<ConfigVersion>>, Error<ErrorResponse>>

Sends a GET request to /config/versions

pub async fn list_credentials<'a>( &'a self, ) -> Result<ResponseValue<CredentialListResponse>, Error<ErrorResponse>>

Sends a GET request to /credentials

pub async fn create_credential<'a>( &'a self, body: &'a CreateCredentialRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a POST request to /credentials

pub async fn delete_credential<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a DELETE request to /credentials/{name}

Arguments:

• name: Credential name

pub async fn health<'a>( &'a self, ) -> Result<ResponseValue<HealthResponse>, Error<()>>

Sends a GET request to /health

pub async fn get_history<'a>( &'a self, ) -> Result<ResponseValue<HistoryResponse>, Error<ErrorResponse>>

Sends a GET request to /history

pub async fn list_pipe_presets<'a>( &'a self, ) -> Result<ResponseValue<PipePresetListResponse>, Error<()>>

Sends a GET request to /pipe-presets

pub async fn create_pipe_preset<'a>( &'a self, body: &'a CreatePipePresetRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a POST request to /pipe-presets

pub async fn get_pipe_preset<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<PipePresetInfo>, Error<ErrorResponse>>

Sends a GET request to /pipe-presets/{name}

Arguments:

• name: Pipe preset name

pub async fn update_pipe_preset<'a>( &'a self, name: &'a str, body: &'a UpdatePipePresetRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a PUT request to /pipe-presets/{name}

Arguments:

• name: Pipe preset name
• body

pub async fn delete_pipe_preset<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a DELETE request to /pipe-presets/{name}

Arguments:

• name: Pipe preset name

pub async fn list_pipes<'a>( &'a self, ) -> Result<ResponseValue<PipeListResponse>, Error<()>>

Sends a GET request to /pipes

pub async fn create_pipe<'a>( &'a self, body: &'a CreatePipeRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a POST request to /pipes

pub async fn dry_run_handler<'a>( &'a self, body: &'a DryRunRequestDoc, ) -> Result<ResponseValue<DryRunResultDoc>, Error<ErrorResponse>>

Sends a POST request to /pipes/dry-run

pub async fn get_pipe<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<PipeInfo>, Error<ErrorResponse>>

Sends a GET request to /pipes/{name}

Arguments:

• name: Pipe name

pub async fn update_pipe<'a>( &'a self, name: &'a str, body: &'a UpdatePipeRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a PUT request to /pipes/{name}

Arguments:

• name: Pipe name
• body

pub async fn delete_pipe<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a DELETE request to /pipes/{name}

Arguments:

• name: Pipe name

pub async fn resolve_pipe_handler<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<PipeResolveResponseDoc>, Error<ErrorResponse>>

Sends a GET request to /pipes/{name}/resolve

Arguments:

• name: Pipe name

pub async fn run_pipe<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<PipeRunResponse>, Error<ErrorResponse>>

Sends a POST request to /pipes/{name}/run

Arguments:

• name: Pipe name

pub async fn list_sinks<'a>( &'a self, ) -> Result<ResponseValue<SinkListResponse>, Error<()>>

Sends a GET request to /sinks

pub async fn create_sink<'a>( &'a self, body: &'a CreateSinkRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a POST request to /sinks

pub async fn update_sink<'a>( &'a self, name: &'a str, body: &'a UpdateSinkRequest, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a PUT request to /sinks/{name}

Arguments:

• name: Sink name
• body

pub async fn delete_sink<'a>( &'a self, name: &'a str, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a DELETE request to /sinks/{name}

Arguments:

• name: Sink name

pub async fn pause_sync<'a>( &'a self, ) -> Result<ResponseValue<MutationResponse>, Error<()>>

Sends a POST request to /sync/pause

pub async fn resume_sync<'a>( &'a self, ) -> Result<ResponseValue<MutationResponse>, Error<ErrorResponse>>

Sends a POST request to /sync/resume

pub async fn sync_status<'a>( &'a self, ) -> Result<ResponseValue<StatusResponse>, Error<()>>

Sends a GET request to /sync/status

Trait Implementations

impl ClientHooks for &Client

async fn pre<E>( &self, request: &mut Request, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs prior to the execution of the request. This may be used to modify the request before it is transmitted.

async fn post<E>( &self, result: &Result<Response, Error>, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs after completion of the request.

async fn exec( &self, request: Request, info: &OperationInfo, ) -> Result<Response, Error>

Execute the request. Note that for almost any reasonable implementation this will include code equivalent to this:

impl ClientInfo<()> for Client

fn api_version() -> &'static str

Get the version of this API.

fn baseurl(&self) -> &str

Get the base URL to which requests are made.

fn client(&self) -> &Client

Get the internal reqwest::Client used to make requests.

fn inner(&self) -> &()

Get the inner value of type T if one is specified.

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.