Struct Client 

pub struct Client { /* private fields */ }

Client for Alien Server API

Control plane for Alien applications. Manages deployments, releases, commands, and telemetry.

Version: 1.0.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 health(&self) -> Health<'_>

Sends a GET request to /health

let response = client.health()
    .send()
    .await;

pub fn list_deployment_groups(&self) -> ListDeploymentGroups<'_>

Sends a GET request to /v1/deployment-groups

let response = client.list_deployment_groups()
    .send()
    .await;

pub fn create_deployment_group(&self) -> CreateDeploymentGroup<'_>

Sends a POST request to /v1/deployment-groups

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

pub fn get_deployment_group(&self) -> GetDeploymentGroup<'_>

Sends a GET request to /v1/deployment-groups/{id}

Arguments:

• id: Deployment group ID

let response = client.get_deployment_group()
    .id(id)
    .send()
    .await;

pub fn create_deployment_group_token(&self) -> CreateDeploymentGroupToken<'_>

Sends a POST request to /v1/deployment-groups/{id}/tokens

Arguments:

• id: Deployment group ID

let response = client.create_deployment_group_token()
    .id(id)
    .send()
    .await;

pub fn list_deployments(&self) -> ListDeployments<'_>

Sends a GET request to /v1/deployments

Arguments:

• deployment_group_id: Filter by deployment group ID
• include: Include related resources (e.g. deploymentGroup)

let response = client.list_deployments()
    .deployment_group_id(deployment_group_id)
    .include(include)
    .send()
    .await;

pub fn create_deployment(&self) -> CreateDeployment<'_>

Sends a POST request to /v1/deployments

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

pub fn get_deployment(&self) -> GetDeployment<'_>

Sends a GET request to /v1/deployments/{id}

Arguments:

• id: Deployment ID

let response = client.get_deployment()
    .id(id)
    .send()
    .await;

pub fn delete_deployment(&self) -> DeleteDeployment<'_>

Sends a DELETE request to /v1/deployments/{id}

Arguments:

• id: Deployment ID

let response = client.delete_deployment()
    .id(id)
    .send()
    .await;

pub fn get_deployment_info(&self) -> GetDeploymentInfo<'_>

Sends a GET request to /v1/deployments/{id}/info

Arguments:

• id: Deployment ID

let response = client.get_deployment_info()
    .id(id)
    .send()
    .await;

pub fn redeploy(&self) -> Redeploy<'_>

Sends a POST request to /v1/deployments/{id}/redeploy

Arguments:

• id: Deployment ID

let response = client.redeploy()
    .id(id)
    .send()
    .await;

pub fn retry_deployment(&self) -> RetryDeployment<'_>

Sends a POST request to /v1/deployments/{id}/retry

Arguments:

• id: Deployment ID

let response = client.retry_deployment()
    .id(id)
    .send()
    .await;

pub fn initialize(&self) -> Initialize<'_>

Sends a POST request to /v1/initialize

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

pub fn create_release(&self) -> CreateRelease<'_>

Sends a POST request to /v1/releases

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

pub fn get_latest_release(&self) -> GetLatestRelease<'_>

Sends a GET request to /v1/releases/latest

let response = client.get_latest_release()
    .send()
    .await;

pub fn get_release(&self) -> GetRelease<'_>

Sends a GET request to /v1/releases/{id}

Arguments:

• id: Release ID

let response = client.get_release()
    .id(id)
    .send()
    .await;

pub fn resolve_credentials(&self) -> ResolveCredentials<'_>

Sends a POST request to /v1/resolve-credentials

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

pub fn operator_sync(&self) -> OperatorSync<'_>

Sends a POST request to /v1/sync

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

pub fn acquire(&self) -> Acquire<'_>

Sends a POST request to /v1/sync/acquire

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

pub fn reconcile(&self) -> Reconcile<'_>

Sends a POST request to /v1/sync/reconcile

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

pub fn release(&self) -> Release<'_>

Sends a POST request to /v1/sync/release

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

pub fn whoami(&self) -> Whoami<'_>

Sends a GET request to /v1/whoami

let response = client.whoami()
    .send()
    .await;

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.