pub struct Client { /* private fields */ }Expand description
Entrypoint for interacting with the API client.
Implementations§
Source§impl Client
impl Client
Sourcepub fn new<T, H>(token: T, host: H) -> Self
pub fn new<T, H>(token: T, host: H) -> Self
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.
Sourcepub fn new_from_env() -> Self
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>
Sourcepub fn disks(&self) -> Disks
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
TODO operations that will not ship to customers.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn images(&self) -> Images
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
Sourcepub fn images_global(&self) -> ImagesGlobal
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
Sourcepub fn instances(&self) -> Instances
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
Sourcepub fn ip_pools(&self) -> IpPools
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
Sourcepub fn metrics(&self) -> Metrics
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
Sourcepub fn organizations(&self) -> Organizations
pub fn organizations(&self) -> Organizations
Organizations represent a subset of users and projects in an Oxide deployment.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn projects(&self) -> Projects
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
Sourcepub fn racks(&self) -> Racks
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
Sourcepub fn roles(&self) -> Roles
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
Sourcepub fn routers(&self) -> Routers
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
Sourcepub fn routes(&self) -> Routes
pub fn routes(&self) -> Routes
Routes define router policy.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn sagas(&self) -> Sagas
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
Sourcepub fn sleds(&self) -> Sleds
pub fn sleds(&self) -> Sleds
This tag should be moved into hardware.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn silos(&self) -> Silos
pub fn silos(&self) -> Silos
Silos represent a logical partition of users and resources.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn snapshots(&self) -> Snapshots
pub fn snapshots(&self) -> Snapshots
Snapshots of Virtual Disks at a particular point in time.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn sshkeys(&self) -> Sshkeys
pub fn sshkeys(&self) -> Sshkeys
Public SSH keys for an individual user.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn subnets(&self) -> Subnets
pub fn subnets(&self) -> Subnets
This tag should be moved into a generic network tag.
FROM: http://oxide.computer/docs/#xxx
Sourcepub fn system(&self) -> System
pub fn system(&self) -> System
Internal system information.
FROM: http://oxide.computer/docs/#xxx