Struct digitalocean::api::Droplet

pub struct Droplet { /* fields omitted */ }

A Droplet is a DigitalOcean virtual machine. By sending requests to the Droplet endpoint, you can list, create, or delete Droplets.

Some of the attributes will have an object value. The region and image objects will all contain the standard attributes of their associated types. Find more information about each of these objects in their respective sections.

Digital Ocean Documentation.

Implementations

impl Droplet

pub fn id(&self) -> &usize

A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.

pub fn name(&self) -> &String

The human-readable name set for the Droplet instance.

pub fn memory(&self) -> &usize

Memory of the Droplet in megabytes.

pub fn vcpus(&self) -> &usize

The number of virtual CPUs.

pub fn disk(&self) -> &usize

The size of the Droplet's disk in gigabytes.

pub fn locked(&self) -> &bool

A boolean value indicating whether the Droplet has been locked, preventing actions by users.

pub fn created_at(&self) -> &DateTime<Utc>

A time value given in ISO8601 combined date and time format that represents when the Droplet was created.

pub fn status(&self) -> &String

A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".

pub fn backup_ids(&self) -> &Vec<usize>

An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.

pub fn snapshot_ids(&self) -> &Vec<usize>

An array of snapshot IDs of any snapshots created from the Droplet instance.

pub fn features(&self) -> &Vec<String>

An array of features enabled on this Droplet.

pub fn region(&self) -> &Region

The region that the Droplet instance is deployed in. When setting a region, the value should be the slug identifier for the region. When you query a Droplet, the entire region object will be returned.

pub fn image(&self) -> &Image

The base image used to create the Droplet instance. When setting an image, the value is set to the image id or slug. When querying the Droplet, the entire image object will be returned.

pub fn size(&self) -> &Size

The current size object describing the Droplet. When setting a size, the value is set to the size slug. When querying the Droplet, the entire size object will be returned. Note that the disk volume of a Droplet may not match the size's disk due to Droplet resize actions. The disk attribute on the Droplet should always be referenced.

pub fn size_slug(&self) -> &String

The unique slug identifier for the size of this Droplet.

pub fn networks(&self) -> &Networks

The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.

pub fn kernel(&self) -> &Option<Kernel>

The current kernel. This will initially be set to the kernel of the base image when the Droplet is created.

pub fn next_backup_window(&self) -> &Option<NextBackupWindow>

The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.

pub fn tags(&self) -> &Vec<String>

An array of Tags the Droplet has been tagged with.

pub fn volume_ids(&self) -> &Vec<String>

A flat array including the unique identifier for each Block Storage volume attached to the Droplet.

impl Droplet

pub fn create<S, D>(
    name: S,
    region: S,
    size: S,
    image: D
) -> DropletRequest<Create, Droplet> where
    S: AsRef<str> + Serialize + Display,
    D: Serialize + Display, 

Digital Ocean Documentation.

pub fn create_multiple<S, D>(
    names: Vec<S>,
    region: S,
    size: S,
    image: D
) -> DropletRequest<Create, Vec<Droplet>> where
    S: AsRef<str> + Serialize + Display,
    D: Serialize + Display, 

Digital Ocean Documentation.

pub fn get(id: usize) -> DropletRequest<Get, Droplet>

Digital Ocean Documentation.

pub fn list() -> DropletRequest<List, Vec<Droplet>>

Digital Ocean Documentation.

pub fn list_by_tag<S: AsRef<str> + Serialize>(
    name: S
) -> DropletRequest<List, Vec<Droplet>>

Digital Ocean Documentation.

pub fn delete(id: usize) -> DropletRequest<Delete, ()>

Digital Ocean Documentation.

pub fn delete_by_tag<S: AsRef<str> + Serialize>(
    name: S
) -> DropletRequest<Delete, ()>

Digital Ocean Documentation.

pub fn neighbors() -> DropletRequest<Get, Vec<Vec<Droplet>>>

Digital Ocean Documentation.

Trait Implementations

impl Clone for Droplet

fn clone(&self) -> Droplet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Droplet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Droplet

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

Deserialize this value from the given Serde deserializer.

impl HasResponse for Droplet

type Response = DropletResponse

impl Serialize for Droplet

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

Serialize this value into the given Serde serializer.