Struct mz_cloud_api::client::Client

pub struct Client {
    pub(crate) inner: Client,
    pub(crate) auth_client: Arc<Client>,
    pub(crate) endpoint: Url,
}

Represents the structure for the client.

Fields

inner: Client

auth_client: Arc<Client>

endpoint: Url

Implementations

impl Client

pub async fn list_cloud_regions(&self) -> Result<Vec<CloudProvider>, Error>

List all the available cloud regions.

E.g.: [us-east-1, eu-west-1]

impl Client

pub async fn get_region(&self, provider: CloudProvider) -> Result<Region, Error>

Get a customer region in a partciular cloud region for the current user.

pub async fn get_all_regions(&self) -> Result<Vec<Region>, Error>

Get all the available customer regions for the current user.

pub async fn create_region( &self, version: Option<String>, environmentd_extra_args: Vec<String>, cloud_provider: CloudProvider, ) -> Result<Region, Error>

Creates a customer region in a particular cloud region for the current user

pub async fn delete_region( &self, cloud_provider: CloudProvider, hard: bool, ) -> Result<(), Error>

Deletes a customer region in a particular cloud region for the current user.

Soft deletes by default.

NOTE that this operation is only available to Materialize employees This operation has a long duration, it can take several minutes to complete. The first few requests will return a 504, indicating that the API is working on the deletion. A request returning a 202 indicates that no region is available to delete (the delete request is complete.)

impl Client

Cloud endpoints architecture:

(CloudProvider) (Region)

---

| | | Region API | | Cloud | url | ––––– ———–– | | Sync | —————> | | Provider | –– | Region | | | | | | (aws..) | | (east-1..) | | | | | ––––– ———–– |

---

async fn build_global_request<P>( &self, method: Method, path: P, query: Option<&[(&str, &str)]>, ) -> Result<RequestBuilder, Error>

where P: IntoIterator, P::Item: AsRef<str>,

Builds a request towards the Client’s endpoint

async fn build_region_request<P>( &self, method: Method, path: P, query: Option<&[(&str, &str)]>, cloud_provider: &CloudProvider, api_version: Option<u16>, ) -> Result<RequestBuilder, Error>

where P: IntoIterator, P::Item: AsRef<str>,

Builds a request towards the Client’s endpoint The function requires a CloudProvider as parameter since it contains the api url (Region API url) to interact with the region. Specify an api_version corresponding to the request/response schema your code will handle. Refer to the Region API docs for schema information.

async fn build_request<P>( &self, method: Method, path: P, query: Option<&[(&str, &str)]>, domain: Url, headers: Option<HeaderMap>, ) -> Result<RequestBuilder, Error>

where P: IntoIterator, P::Item: AsRef<str>,

Builds a request towards the Client’s endpoint

async fn send_request<T>(&self, req: RequestBuilder) -> Result<T, Error>

where T: DeserializeOwned,