Struct oxide_api::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Entrypoint for interacting with the API client.

Implementations

impl Client

pub fn new<T, H>(token: T, host: H) -> Self where
T: ToString,
H: ToString,

Create a new Client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work.

pub fn new_from_env() -> Self

Create a new Client struct from environment variables: OXIDE_TOKEN and OXIDE_HOST.

pub async fn request_raw(
    &self,
    method: Method,
    uri: &str,
    body: Option<Body>
) -> Result<RequestBuilder>

pub async fn response_raw(
    &self,
    method: Method,
    uri: &str,
    body: Option<Body>
) -> Result<Response>

pub fn disks(&self) -> Disks

Virtual disks are used to store instance-local data which includes the operating system.

FROM: http://oxide.computer/docs/#xxx

pub fn firewall(&self) -> Firewall

Firewall operation controls the flow of network data into a VPC.

FROM: http://oxide.computer/docs/#xxx

pub fn hidden(&self) -> Hidden

TODO operations that will not ship to customers.

FROM: http://oxide.computer/docs/#xxx

pub fn images(&self) -> Images

Images are read-only Virtual Disks that may be used to boot Virtual Machines.

FROM: http://oxide.computer/docs/#xxx

pub fn images_global(&self) -> ImagesGlobal

Images are read-only Virtual Disks that may be used to boot Virtual Machines. These images are scoped globally.

FROM: http://oxide.computer/docs/#xxx

pub fn instances(&self) -> Instances

Virtual machine instances are the basic unit of computation. These operations are used for provisioning, controlling, and destroying instances.

FROM: http://oxide.computer/docs/#xxx

pub fn ip_pools(&self) -> IpPools

IP Pools contain external IP addresses that can be assigned to virtual machine Instances.

FROM: http://oxide.computer/docs/#xxx

Authentication endpoints.

FROM: http://oxide.computer/docs/#xxx

pub fn metrics(&self) -> Metrics

Metrics provide insight into the operation of the Oxide deployment. These include telemetry on hardware and software components that can be used to understand the current state as well as to diagnose issues.

FROM: http://oxide.computer/docs/#xxx

pub fn organizations(&self) -> Organizations

Organizations represent a subset of users and projects in an Oxide deployment.

FROM: http://oxide.computer/docs/#xxx

pub fn policy(&self) -> Policy

System-wide IAM policy.

FROM: http://oxide.computer/docs/#xxx

pub fn projects(&self) -> Projects

Projects are a grouping of associated resources such as instances and disks within an organization for purposes of billing and access control.

FROM: http://oxide.computer/docs/#xxx

pub fn racks(&self) -> Racks

These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.

FROM: http://oxide.computer/docs/#xxx

pub fn roles(&self) -> Roles

Roles are a component of Identity and Access Management (IAM) that allow a user or agent account access to additional permissions.

FROM: http://oxide.computer/docs/#xxx

pub fn routers(&self) -> Routers

Routers direct the flow of network traffic into, out of, and within a VPC via routes.

FROM: http://oxide.computer/docs/#xxx

pub fn routes(&self) -> Routes

Routes define router policy.

FROM: http://oxide.computer/docs/#xxx

pub fn sagas(&self) -> Sagas

Sagas are the abstraction used to represent multi-step operations within the Oxide deployment. These operations can be used to query saga status and report errors.

FROM: http://oxide.computer/docs/#xxx

pub fn silos(&self) -> Silos

Silos represent a logical partition of users and resources.

FROM: http://oxide.computer/docs/#xxx

pub fn sleds(&self) -> Sleds

This tag should be moved into hardware.

FROM: http://oxide.computer/docs/#xxx

pub fn snapshots(&self) -> Snapshots

Snapshots of Virtual Disks at a particular point in time.

FROM: http://oxide.computer/docs/#xxx

pub fn sshkeys(&self) -> Sshkeys

Public SSH keys for an individual user.

FROM: http://oxide.computer/docs/#xxx

pub fn subnets(&self) -> Subnets

This tag should be moved into a generic network tag.

FROM: http://oxide.computer/docs/#xxx

pub fn system(&self) -> System

Internal system information.

FROM: http://oxide.computer/docs/#xxx

pub fn updates(&self) -> Updates

This tag should be moved into a operations tag.

FROM: http://oxide.computer/docs/#xxx

pub fn vpcs(&self) -> Vpcs

A Virtual Private Cloud (VPC) is an isolated network environment that should probaby be moved into a more generic networking tag.

FROM: http://oxide.computer/docs/#xxx

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

fn __clone_box(&self, Private) -> *mut ()

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

impl<T> IntoResult<T> for T

type Err = Infallible

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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