Struct Client 

pub struct Client { /* private fields */ }

Client for DeepStore API

Log storage and search database control plane API

Version: 0.1.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 fn create_database(&self) -> CreateDatabase<'_>

Create a new database. Returns a service token (one-time only).

Sends a POST request to /databases

let response = client.create_database()
    .body(body)
    .send()
    .await;

pub fn get_database(&self) -> GetDatabase<'_>

Get database information

Sends a GET request to /databases/{databaseId}

let response = client.get_database()
    .database_id(database_id)
    .send()
    .await;

pub fn delete_database(&self) -> DeleteDatabase<'_>

Delete a database and all its data

Sends a DELETE request to /databases/{databaseId}

let response = client.delete_database()
    .database_id(database_id)
    .send()
    .await;

pub fn commit_draft(&self) -> CommitDraft<'_>

Commit draft metadata after uploading to object storage

Sends a POST request to /databases/{databaseId}/commit-draft

let response = client.commit_draft()
    .database_id(database_id)
    .body(body)
    .send()
    .await;

pub fn list_drafts(&self) -> ListDrafts<'_>

List drafts, optionally filtered by scopes from JWT

Sends a GET request to /databases/{databaseId}/drafts

let response = client.list_drafts()
    .database_id(database_id)
    .limit(limit)
    .send()
    .await;

pub fn list_splits(&self) -> ListSplits<'_>

List published splits within a time range

Sends a GET request to /databases/{databaseId}/splits

let response = client.list_splits()
    .database_id(database_id)
    .end_timestamp(end_timestamp)
    .limit(limit)
    .start_timestamp(start_timestamp)
    .send()
    .await;

pub fn lease_indexing_job(&self) -> LeaseIndexingJob<'_>

Lease an indexing job (lock drafts for indexing)

Sends a POST request to /databases/{databaseId}/indexing-jobs/lease

let response = client.lease_indexing_job()
    .database_id(database_id)
    .body(body)
    .send()
    .await;

pub fn complete_indexing_job(&self) -> CompleteIndexingJob<'_>

Complete an indexing job

Sends a POST request to /databases/{databaseId}/indexing-jobs/{jobId}/complete

let response = client.complete_indexing_job()
    .database_id(database_id)
    .job_id(job_id)
    .body(body)
    .send()
    .await;

pub fn lease_cleanup_job(&self) -> LeaseCleanupJob<'_>

Lease a draft cleanup job

Sends a POST request to /databases/{databaseId}/cleanup-jobs/lease

let response = client.lease_cleanup_job()
    .database_id(database_id)
    .body(body)
    .send()
    .await;

pub fn complete_cleanup_job(&self) -> CompleteCleanupJob<'_>

Complete a draft cleanup job

Sends a POST request to /databases/{databaseId}/cleanup-jobs/{jobId}/complete

let response = client.complete_cleanup_job()
    .database_id(database_id)
    .job_id(job_id)
    .body(body)
    .send()
    .await;

pub fn lease_merge_job(&self) -> LeaseMergeJob<'_>

Lease a merge job

Sends a POST request to /databases/{databaseId}/merge-jobs/lease

let response = client.lease_merge_job()
    .database_id(database_id)
    .body(body)
    .send()
    .await;

pub fn complete_merge_job(&self) -> CompleteMergeJob<'_>

Complete a merge job

Sends a POST request to /databases/{databaseId}/merge-jobs/{jobId}/complete

let response = client.complete_merge_job()
    .database_id(database_id)
    .job_id(job_id)
    .body(body)
    .send()
    .await;

pub fn lease_split_cleanup_job(&self) -> LeaseSplitCleanupJob<'_>

Lease a split cleanup job

Sends a POST request to /databases/{databaseId}/split-cleanup-jobs/lease

let response = client.lease_split_cleanup_job()
    .database_id(database_id)
    .body(body)
    .send()
    .await;

pub fn complete_split_cleanup_job(&self) -> CompleteSplitCleanupJob<'_>

Complete a split cleanup job

Sends a POST request to /databases/{databaseId}/split-cleanup-jobs/{jobId}/complete

let response = client.complete_split_cleanup_job()
    .database_id(database_id)
    .job_id(job_id)
    .body(body)
    .send()
    .await;

pub fn rotate_service_token(&self) -> RotateServiceToken<'_>

Rotate service token (platform auth only)

Sends a POST request to /databases/{databaseId}/tokens/rotate

let response = client.rotate_service_token()
    .database_id(database_id)
    .send()
    .await;

pub fn revoke_service_tokens(&self) -> RevokeServiceTokens<'_>

Revoke all service tokens (platform auth only)

Sends a POST request to /databases/{databaseId}/tokens/revoke

let response = client.revoke_service_tokens()
    .database_id(database_id)
    .send()
    .await;

impl Client

pub fn new_authenticated(base_url: &str, token: &str, timeout: Duration) -> Self

Create an authenticated client using a bearer token.

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.