Struct shuttle_api_client::ShuttleApiClient

source ·
pub struct ShuttleApiClient {
    pub client: ClientWithMiddleware,
    pub api_url: String,
    pub api_key: Option<String>,
}

Fields§

§client: ClientWithMiddleware§api_url: String§api_key: Option<String>

Implementations§

source§

impl ShuttleApiClient

source

pub fn new( api_url: String, api_key: Option<String>, headers: Option<HeaderMap>, ) -> Self

source

pub fn set_auth_bearer(&self, builder: RequestBuilder) -> RequestBuilder

source

pub async fn get_api_versions(&self) -> Result<VersionInfo>

source

pub async fn check_project_name(&self, project_name: &str) -> Result<bool>

source

pub async fn check_project_name_beta(&self, project_name: &str) -> Result<bool>

source

pub async fn get_current_user(&self) -> Result<Response>

source

pub async fn deploy( &self, project: &str, deployment_req: DeploymentRequest, ) -> Result<Response>

source

pub async fn deploy_beta( &self, project: &str, deployment_req: DeploymentRequestBeta, ) -> Result<ResponseBeta>

source

pub async fn upload_archive_beta( &self, project: &str, data: Vec<u8>, ) -> Result<UploadArchiveResponseBeta>

source

pub async fn stop_service(&self, project: &str) -> Result<Summary>

source

pub async fn stop_service_beta(&self, project: &str) -> Result<String>

source

pub async fn get_service(&self, project: &str) -> Result<Summary>

source

pub async fn get_service_resources( &self, project: &str, ) -> Result<Vec<Response>>

source

pub async fn get_service_resources_beta( &self, project: &str, ) -> Result<Vec<Response>>

source

pub async fn delete_service_resource( &self, project: &str, resource_type: &Type, ) -> Result<()>

source

pub async fn delete_service_resource_beta( &self, project: &str, resource_type: &Type, ) -> Result<()>

source

pub async fn create_project( &self, project: &str, config: &Config, ) -> Result<Response>

source

pub async fn create_project_beta(&self, name: &str) -> Result<ResponseBeta>

source

pub async fn clean_project(&self, project: &str) -> Result<String>

source

pub async fn get_project(&self, project: &str) -> Result<Response>

source

pub async fn get_project_beta(&self, project: &str) -> Result<ResponseBeta>

source

pub async fn get_projects_list(&self) -> Result<Vec<Response>>

source

pub async fn get_projects_list_beta(&self) -> Result<ResponseListBeta>

source

pub async fn stop_project(&self, project: &str) -> Result<Response>

source

pub async fn delete_project(&self, project: &str) -> Result<String>

source

pub async fn delete_project_beta(&self, project: &str) -> Result<String>

source

pub async fn get_teams_list(&self) -> Result<Vec<Response>>

source

pub async fn get_team_projects_list( &self, team_id: &str, ) -> Result<Vec<Response>>

source

pub async fn get_team_projects_list_beta( &self, team_id: &str, ) -> Result<ResponseListBeta>

source

pub async fn get_logs( &self, project: &str, deployment_id: &str, range: LogsRange, ) -> Result<Vec<LogItem>>

source

pub async fn get_deployment_logs_beta( &self, project: &str, deployment_id: &str, ) -> Result<LogsResponseBeta>

source

pub async fn get_project_logs_beta( &self, project: &str, ) -> Result<LogsResponseBeta>

source

pub async fn get_logs_ws( &self, project: &str, deployment_id: &str, range: LogsRange, ) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>>

source

pub async fn get_deployments( &self, project: &str, page: u32, limit: u32, ) -> Result<Vec<Response>>

source

pub async fn get_deployments_beta( &self, project: &str, ) -> Result<Vec<ResponseBeta>>

source

pub async fn get_current_deployment_beta( &self, project: &str, ) -> Result<Option<ResponseBeta>>

source

pub async fn get_deployment_beta( &self, project: &str, deployment_id: &str, ) -> Result<ResponseBeta>

source

pub async fn get_deployment_details( &self, project: &str, deployment_id: &Uuid, ) -> Result<Response>

source

pub async fn reset_api_key(&self) -> Result<Response>

source

pub async fn ws_get( &self, path: String, ) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>>

source

pub async fn get(&self, path: impl AsRef<str>) -> Result<Response>

source

pub async fn get_json<R>(&self, path: impl AsRef<str>) -> Result<R>
where R: for<'de> Deserialize<'de>,

source

pub async fn post<T: Serialize>( &self, path: impl AsRef<str>, body: Option<T>, ) -> Result<Response>

source

pub async fn post_json<T: Serialize, R>( &self, path: impl AsRef<str>, body: Option<T>, ) -> Result<R>
where R: for<'de> Deserialize<'de>,

source

pub async fn put<T: Serialize>( &self, path: impl AsRef<str>, body: Option<T>, ) -> Result<Response>

source

pub async fn put_json<T: Serialize, R>( &self, path: impl AsRef<str>, body: Option<T>, ) -> Result<R>
where R: for<'de> Deserialize<'de>,

source

pub async fn delete(&self, path: impl AsRef<str>) -> Result<Response>

source

pub async fn delete_json<R>(&self, path: impl AsRef<str>) -> Result<R>
where R: for<'de> Deserialize<'de>,

Trait Implementations§

source§

impl Clone for ShuttleApiClient

source§

fn clone(&self) -> ShuttleApiClient

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more