Struct mz_cloud_api::client::Client

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

Represents the structure for the client.

Fields§

§inner: Client§auth_client: Arc<Client>§endpoint: Url

Implementations§

source§

impl Client

source

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]

source§

impl Client

source

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

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

source

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

Get all the available customer regions for the current user.

source

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

source

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

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

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.)

source§

impl Client

Cloud endpoints architecture:

(CloudProvider) (Region)


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


source

async fn build_global_request<P>( &self, method: Method, path: P ) -> Result<RequestBuilder, Error>
where P: IntoIterator, P::Item: AsRef<str>,

Builds a request towards the Client’s endpoint

source

async fn build_region_request<P>( &self, method: Method, path: P, 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.

source

async fn build_request<P>( &self, method: Method, path: P, domain: Url, headers: Option<HeaderMap> ) -> Result<RequestBuilder, Error>
where P: IntoIterator, P::Item: AsRef<str>,

Builds a request towards the Client’s endpoint

source

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

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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, U> CastInto<U> for T
where U: CastFrom<T>,

source§

fn cast_into(self) -> U

Performs the cast.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T, U> OverrideFrom<Option<&T>> for U
where U: OverrideFrom<T>,

source§

fn override_from(self, layer: &Option<&T>) -> U

Override the configuration represented by Self with values from the given layer.
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<P, R> ProtoType<R> for P
where R: RustType<P>,

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<'a, S, T> Semigroup<&'a S> for T
where T: Semigroup<S>,

source§

fn plus_equals(&mut self, rhs: &&'a S)

The method of std::ops::AddAssign, for types that do not implement AddAssign.
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