Struct oxide_api::types::Instance

pub struct Instance {
    pub id: String,
    pub name: String,
    pub description: String,
    pub hostname: String,
    pub memory: u64,
    pub ncpus: u16,
    pub project_id: String,
    pub run_state: InstanceState,
    pub time_created: DisplayOptionDateTime,
    pub time_modified: DisplayOptionDateTime,
    pub time_run_state_updated: DisplayOptionDateTime,
}

Client view of an Instance

Fields

id: String

unique, immutable, system-controlled identifier for each resource

name: String

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

description: String

human-readable free-form text about a resource

hostname: String

RFC1035-compliant hostname for the Instance.

memory: u64

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.

ncpus: u16

The number of CPUs in an Instance

project_id: String

id for the project containing this Instance

run_state: InstanceState

Running state of an Instance (primarily: booted or stopped)

This typically reflects whether it’s starting, running, stopping, or stopped, but also includes states related to the Instance’s lifecycle

time_created: DisplayOptionDateTime

timestamp when this resource was created

time_modified: DisplayOptionDateTime

timestamp when this resource was last modified

time_run_state_updated: DisplayOptionDateTime

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Instance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Instance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Instance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Instance

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<Instance> for Instance

fn eq(&self, other: &Instance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Instance) -> bool

This method tests for !=.

impl Serialize for Instance

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Tabled for Instance

const LENGTH: usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<String>

Fields method must return a list of cells.

fn headers() -> Vec<String>

Headers must return a list of column names.

impl StructuralPartialEq for Instance