Struct oxide_api::instances::Instances

source · [−]

pub struct Instances {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Instances

source

pub async fn get_page(
 &self,
 limit: u32,
 organization_name: &str,
 page_token: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<Instance>>

List instances in a project.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances endpoint.

Parameters:

limit: u32 – A count of bytes, typically used either for memory or storage capacity

The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.

page_token: &str – Token returned by previous call to retreive the subsequent page.
sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name only

Currently, we only support scanning in ascending order.

organization_name: &str – human-readable free-form text about a resource.
project_name: &str – The project’s unique name within the organization.

source

pub async fn get_all(
 &self,
 organization_name: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<Instance>>

List instances in a project.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances endpoint.

As opposed to get, this function returns all the pages of the request at once.

source

pub async fn post(
 &self,
 organization_name: &str,
 project_name: &str,
 body: &InstanceCreate
) -> Result<Instance>

Create an instance in a project.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances endpoint.

Parameters:

organization_name: &str – human-readable free-form text about a resource.
project_name: &str – The project’s unique name within the organization.

source

pub async fn get(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<Instance>

Get an instance in a project.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name} endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn delete(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<()>

Delete an instance from a project.

This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name} endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn disks_get(
 &self,
 instance_name: &str,
 limit: u32,
 organization_name: &str,
 page_token: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<Disk>>

List disks attached to this instance.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks endpoint.

Parameters:

limit: u32 – A count of bytes, typically used either for memory or storage capacity

The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.

page_token: &str – Token returned by previous call to retreive the subsequent page.
sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name only

Currently, we only support scanning in ascending order.

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn disks_get_all(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<Disk>>

List disks attached to this instance.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks endpoint.

As opposed to disks_get, this function returns all the pages of the request at once.

source

pub async fn disks_attach(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str,
 body: &DiskIdentifier
) -> Result<Disk>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks/attach endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn disks_detach(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str,
 body: &DiskIdentifier
) -> Result<Disk>

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/disks/detach endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn migrate(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str,
 body: &InstanceMigrate
) -> Result<Instance>

Migrate an instance to a different propolis-server, possibly on a different sled.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/migrate endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn network_interfaces_get(
 &self,
 instance_name: &str,
 limit: u32,
 organization_name: &str,
 page_token: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<NetworkInterface>>

List network interfaces attached to this instance.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces endpoint.

Parameters:

limit: u32 – A count of bytes, typically used either for memory or storage capacity

The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.

page_token: &str – Token returned by previous call to retreive the subsequent page.
sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name only

Currently, we only support scanning in ascending order.

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn network_interfaces_get_all(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str,
 sort_by: NameSortMode
) -> Result<Vec<NetworkInterface>>

List network interfaces attached to this instance.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces endpoint.

As opposed to network_interfaces_get, this function returns all the pages of the request at once.

source

pub async fn network_interfaces_post(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str,
 body: &NetworkInterfaceCreate
) -> Result<NetworkInterface>

Create a network interface for an instance.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn network_interfaces_get_interface(
 &self,
 instance_name: &str,
 interface_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<NetworkInterface>

Get an interface attached to an instance.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces/{interface_name} endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
interface_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn network_interfaces_delete_interface(
 &self,
 instance_name: &str,
 interface_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<()>

Detach a network interface from an instance.

This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/network-interfaces/{interface_name} endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
interface_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn reboot(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<Instance>

Reboot an instance.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/reboot endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn start(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<Instance>

Boot an instance.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/start endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

source

pub async fn stop(
 &self,
 instance_name: &str,
 organization_name: &str,
 project_name: &str
) -> Result<Instance>

Halt an instance.

This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/instances/{instance_name}/stop endpoint.

Parameters:

instance_name: &str – human-readable free-form text about a resource.
organization_name: &str – human-readable free-form text about a resource.
project_name: &str – human-readable free-form text about a resource.

Auto Trait Implementations

impl !RefUnwindSafe for Instances

impl Send for Instances

impl Sync for Instances

impl Unpin for Instances

impl !UnwindSafe for Instances

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

Struct oxide_api::instances::Instances

Fields

Implementations

impl Instances

pub async fn get_page( &self, limit: u32, organization_name: &str, page_token: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<Instance>>

pub async fn get_all( &self, organization_name: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<Instance>>

pub async fn post( &self, organization_name: &str, project_name: &str, body: &InstanceCreate) -> Result<Instance>

pub async fn get( &self, instance_name: &str, organization_name: &str, project_name: &str) -> Result<Instance>

pub async fn delete( &self, instance_name: &str, organization_name: &str, project_name: &str) -> Result<()>

pub async fn disks_get( &self, instance_name: &str, limit: u32, organization_name: &str, page_token: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<Disk>>

pub async fn disks_get_all( &self, instance_name: &str, organization_name: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<Disk>>

pub async fn disks_attach( &self, instance_name: &str, organization_name: &str, project_name: &str, body: &DiskIdentifier) -> Result<Disk>

pub async fn disks_detach( &self, instance_name: &str, organization_name: &str, project_name: &str, body: &DiskIdentifier) -> Result<Disk>

pub async fn migrate( &self, instance_name: &str, organization_name: &str, project_name: &str, body: &InstanceMigrate) -> Result<Instance>

pub async fn network_interfaces_get( &self, instance_name: &str, limit: u32, organization_name: &str, page_token: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<NetworkInterface>>

pub async fn network_interfaces_get_all( &self, instance_name: &str, organization_name: &str, project_name: &str, sort_by: NameSortMode) -> Result<Vec<NetworkInterface>>

pub async fn network_interfaces_post( &self, instance_name: &str, organization_name: &str, project_name: &str, body: &NetworkInterfaceCreate) -> Result<NetworkInterface>

pub async fn network_interfaces_get_interface( &self, instance_name: &str, interface_name: &str, organization_name: &str, project_name: &str) -> Result<NetworkInterface>

pub async fn network_interfaces_delete_interface( &self, instance_name: &str, interface_name: &str, organization_name: &str, project_name: &str) -> Result<()>

pub async fn reboot( &self, instance_name: &str, organization_name: &str, project_name: &str) -> Result<Instance>

pub async fn start( &self, instance_name: &str, organization_name: &str, project_name: &str) -> Result<Instance>

pub async fn stop( &self, instance_name: &str, organization_name: &str, project_name: &str) -> Result<Instance>

Auto Trait Implementations

impl !RefUnwindSafe for Instances

impl Send for Instances

impl Sync for Instances

impl Unpin for Instances

impl !UnwindSafe for Instances

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn get_page(
&self,
limit: u32,
organization_name: &str,
page_token: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<Instance>>

pub async fn get_all(
&self,
organization_name: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<Instance>>

pub async fn post(
&self,
organization_name: &str,
project_name: &str,
body: &InstanceCreate
) -> Result<Instance>

pub async fn get(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str
) -> Result<Instance>

pub async fn delete(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str
) -> Result<()>

pub async fn disks_get(
&self,
instance_name: &str,
limit: u32,
organization_name: &str,
page_token: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<Disk>>

pub async fn disks_get_all(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<Disk>>

pub async fn disks_attach(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
body: &DiskIdentifier
) -> Result<Disk>

pub async fn disks_detach(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
body: &DiskIdentifier
) -> Result<Disk>

pub async fn migrate(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
body: &InstanceMigrate
) -> Result<Instance>

pub async fn network_interfaces_get(
&self,
instance_name: &str,
limit: u32,
organization_name: &str,
page_token: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<NetworkInterface>>

pub async fn network_interfaces_get_all(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
sort_by: NameSortMode
) -> Result<Vec<NetworkInterface>>

pub async fn network_interfaces_post(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str,
body: &NetworkInterfaceCreate
) -> Result<NetworkInterface>

pub async fn network_interfaces_get_interface(
&self,
instance_name: &str,
interface_name: &str,
organization_name: &str,
project_name: &str
) -> Result<NetworkInterface>

pub async fn network_interfaces_delete_interface(
&self,
instance_name: &str,
interface_name: &str,
organization_name: &str,
project_name: &str
) -> Result<()>

pub async fn reboot(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str
) -> Result<Instance>

pub async fn start(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str
) -> Result<Instance>

pub async fn stop(
&self,
instance_name: &str,
organization_name: &str,
project_name: &str
) -> Result<Instance>

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,