Struct Request

pub struct Request<A: Method, R> { /* private fields */ }

A consuming builder which can be used to build up API calls.

In general consumers of the crate should not need to use this type directly. Instead, build up requests from what is found in api::*.

Implementations

impl Request<Create, Certificate>

pub fn certificate_chain<S: AsRef<str> + Serialize + Display>( self, val: S, ) -> Self

The full PEM-formatted trust chain between the certificate authority’s certificate and your domain’s SSL certificate.

Digital Ocean Documentation.

impl Request<Get, Domain>

pub fn records(self) -> DomainRecordRequest<List, Vec<DomainRecord>>

Digital Ocean Documentation.

impl Request<List, Vec<DomainRecord>>

pub fn create<S: AsRef<str> + Display + Serialize>( self, kind: S, name: S, data: S, ) -> DomainRecordRequest<Create, DomainRecord>

Digital Ocean Documentation.

pub fn get(self, id: usize) -> DomainRecordRequest<Get, DomainRecord>

Digital Ocean Documentation.

pub fn update(self, id: usize) -> DomainRecordRequest<Update, DomainRecord>

Digital Ocean Documentation.

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

Digital Ocean Documentation.

impl Request<Create, DomainRecord>

pub fn priority(self, val: Option<usize>) -> Self

The priority for SRV and MX records.

Digital Ocean Documentation.

pub fn port(self, val: Option<usize>) -> Self

The port for SRV records.

Digital Ocean Documentation.

pub fn ttl(self, val: usize) -> Self

This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.

Digital Ocean Documentation.

pub fn weight(self, val: Option<usize>) -> Self

The weight for SRV records.

Digital Ocean Documentation.

impl Request<Update, DomainRecord>

pub fn kind<S: AsRef<str> + Display + Serialize>(self, val: S) -> Self

The record type (A, MX, CNAME, etc).

Digital Ocean Documentation.

pub fn name<S: AsRef<str> + Display + Serialize>(self, val: S) -> Self

The host name, alias, or service being defined by the record.

Digital Ocean Documentation.

pub fn data<S: AsRef<str> + Display + Serialize>(self, val: S) -> Self

Variable data depending on record type. See the Domain Records section for more detail on each record type.

Digital Ocean Documentation.

pub fn priority(self, val: Option<usize>) -> Self

The priority for SRV and MX records.

Digital Ocean Documentation.

pub fn port(self, val: Option<usize>) -> Self

The port for SRV records.

Digital Ocean Documentation.

pub fn ttl(self, val: usize) -> Self

This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.

Digital Ocean Documentation.

pub fn weight(self, val: Option<usize>) -> Self

The weight for SRV records.

Digital Ocean Documentation.

impl Request<Create, Droplet>

pub fn ssh_keys<D>(self, val: Vec<D>) -> Self

where D: Display + Serialize,

An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet’s root account upon creation.

Digital Ocean Documentation.

pub fn backups(self, val: bool) -> Self

A boolean indicating whether automated backups should be enabled for the Droplet. Automated backups can only be enabled when the Droplet is created.

Digital Ocean Documentation.

pub fn ipv6(self, val: bool) -> Self

A boolean indicating whether IPv6 is enabled on the Droplet.

Digital Ocean Documentation.

pub fn private_networking(self, val: bool) -> Self

A boolean indicating whether private networking is enabled for the Droplet. Private networking is currently only available in certain regions.

Digital Ocean Documentation.

pub fn user_data(self, val: bool) -> Self

A string containing ‘user data’ which may be used to configure the Droplet on first boot, often a ‘cloud-config’ file or Bash script. It must be plain text and may not exceed 64 KiB in size.

Digital Ocean Documentation.

pub fn monitoring(self, val: bool) -> Self

A boolean indicating whether to install the DigitalOcean agent for monitoring.

Digital Ocean Documentation.

pub fn volumes(self, val: Vec<String>) -> Self

A flat array including the unique string identifier for each Block Storage volume to be attached to the Droplet. At the moment a volume can only be attached to a single Droplet.

Digital Ocean Documentation.

pub fn tags(self, val: Vec<String>) -> Self

A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.

Digital Ocean Documentation.

impl Request<Create, Vec<Droplet>>

pub fn ssh_keys<D>(self, val: Vec<D>) -> Self

where D: Display + Serialize,

An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet’s root account upon creation.

Digital Ocean Documentation.

pub fn backups(self, val: bool) -> Self

A boolean indicating whether automated backups should be enabled for the Droplet. Automated backups can only be enabled when the Droplet is created.

Digital Ocean Documentation.

pub fn ipv6(self, val: bool) -> Self

A boolean indicating whether IPv6 is enabled on the Droplet.

Digital Ocean Documentation.

pub fn private_networking(self, val: bool) -> Self

A boolean indicating whether private networking is enabled for the Droplet. Private networking is currently only available in certain regions.

Digital Ocean Documentation.

pub fn user_data(self, val: bool) -> Self

A string containing ‘user data’ which may be used to configure the Droplet on first boot, often a ‘cloud-config’ file or Bash script. It must be plain text and may not exceed 64 KiB in size.

Digital Ocean Documentation.

pub fn monitoring(self, val: bool) -> Self

A boolean indicating whether to install the DigitalOcean agent for monitoring.

Digital Ocean Documentation.

pub fn volumes(self, val: Vec<String>) -> Self

A flat array including the unique string identifier for each Block Storage volume to be attached to the Droplet. At the moment a volume can only be attached to a single Droplet.

Digital Ocean Documentation.

pub fn tags(self, val: Vec<String>) -> Self

A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.

Digital Ocean Documentation.

impl Request<Get, Droplet>

pub fn snapshots(self) -> SnapshotRequest<List, Vec<Snapshot>>

Digital Ocean Documentation.

pub fn backups(self) -> SnapshotRequest<List, Vec<Snapshot>>

Digital Ocean Documentation.

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

Digital Ocean Documentation.

impl Request<Get, Droplet>

pub fn actions(self) -> DropletActionRequest<List, Vec<Action>>

Digital Ocean Documentation.

pub fn enable_backups(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn disable_backups(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn reboot(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn power_cycle(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn shutdown(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn power(self, val: bool) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn restore<D: Display>( self, image: D, ) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn password_reset(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn resize<S>( self, size: S, disk: bool, ) -> DropletActionRequest<Create, Action>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn rebuild<S>(self, image: S) -> DropletActionRequest<Create, Action>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn rename<S>(self, name: S) -> DropletActionRequest<Create, Action>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn kernel(self, kernel: usize) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn enable_ipv6(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn enable_private_networking(self) -> DropletActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn snapshot<S>(self, name: S) -> DropletActionRequest<Create, Action>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn action(self, id: usize) -> DropletActionRequest<Get, Action>

Digital Ocean Documentation.

impl Request<Get, FloatingIp>

pub fn actions(self) -> FloatingIpActionRequest<List, Vec<Action>>

Digital Ocean Documentation.

pub fn action(self, id: usize) -> FloatingIpActionRequest<Get, Action>

Digital Ocean Documentation.

pub fn unassign(self) -> FloatingIpActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn assign(self, id: usize) -> FloatingIpActionRequest<Create, Action>

Digital Ocean Documentation.

impl Request<Update, Image>

pub fn name<S: Display + Serialize>(self, val: S) -> ImageRequest<Update, Image>

The new name that you would like to use for the image.

Digital Ocean Documentation.

impl Request<Get, Image>

pub fn actions(self) -> ImageActionRequest<List, Vec<Action>>

Digital Ocean Documentation.

pub fn transfer<S>(self, region: S) -> ImageActionRequest<Create, Action>

where S: AsRef<str> + Display + Serialize,

Digital Ocean Documentation.

pub fn convert(self) -> ImageActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn action(self, id: usize) -> ImageActionRequest<Get, Action>

Digital Ocean Documentation.

impl Request<Create, LoadBalancer>

pub fn algorithm<S>(self, val: S) -> LoadBalancerRequest<Create, LoadBalancer>

where S: Display + Serialize,

The load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either “round_robin” or “least_connections”. The default value is “round_robin”.

Digital Ocean Documentation.

pub fn forwarding_rule<T>( self, val: T, ) -> LoadBalancerRequest<Create, LoadBalancer>

where T: Into<ForwardingRule>,

An array of objects specifying the forwarding rules for a Load Balancer. At least one forwarding rule is required when creating a new Load Balancer instance.

Digital Ocean Documentation.

pub fn health_check<S: AsRef<str> + Display + Serialize>( self, protocol: S, port: usize, path: Option<S>, check_interval_seconds: Option<usize>, response_timeout_seconds: Option<usize>, unhealthy_threshold: Option<usize>, healthy_threshold: Option<usize>, ) -> LoadBalancerRequest<Create, LoadBalancer>

The (optional) health check settings.

Digital Ocean Documentation.

pub fn sticky_sessions<S: AsRef<str> + Display + Serialize>( self, kind: S, cookie_name: Option<S>, cookie_ttl_seconds: Option<usize>, ) -> LoadBalancerRequest<Create, LoadBalancer>

The (optional) sticky sessions settings. kind must be cookies or none. If kind is cookies then cookie_name and cookie_ttl_seconds should be set as well.

Digital Ocean Documentation.

pub fn redirect_http_to_https( self, setting: bool, ) -> LoadBalancerRequest<Create, LoadBalancer>

A boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.

Digital Ocean Documentation.

pub fn droplets( self, ids: Vec<usize>, ) -> LoadBalancerRequest<Create, LoadBalancer>

The IDs of the Droplets to be assigned to the Load Balancer.

Note: Not intended to be used alongside the tag function.

Digital Ocean Documentation.

pub fn tag<S>(self, tag: S) -> LoadBalancerRequest<Create, LoadBalancer>

where S: AsRef<str> + Display + Serialize,

The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.

Note: Not intended to be used alongside the droplets function.

Digital Ocean Documentation.

impl Request<Update, LoadBalancer>

pub fn name<S>(self, val: S) -> LoadBalancerRequest<Update, LoadBalancer>

where S: Display + Serialize,

A human-readable name for a Load Balancer instance.

Digital Ocean Documentation.

pub fn region<S>(self, val: S) -> LoadBalancerRequest<Update, LoadBalancer>

where S: Display + Serialize,

The region where the Load Balancer instance will be located.

Digital Ocean Documentation.

pub fn algorithm<S>(self, val: S) -> LoadBalancerRequest<Update, LoadBalancer>

where S: Display + Serialize,

The load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either “round_robin” or “least_connections”. The default value is “round_robin”.

Digital Ocean Documentation.

pub fn forwarding_rule<T>( self, val: T, ) -> LoadBalancerRequest<Update, LoadBalancer>

where T: Into<ForwardingRule>,

An array of objects specifying the forwarding rules for a Load Balancer. At least one forwarding rule is required when creating a new Load Balancer instance.

Digital Ocean Documentation.

pub fn health_check<S: AsRef<str> + Display + Serialize>( self, protocol: S, port: usize, path: Option<S>, check_interval_seconds: Option<usize>, response_timeout_seconds: Option<usize>, unhealthy_threshold: Option<usize>, healthy_threshold: Option<usize>, ) -> LoadBalancerRequest<Update, LoadBalancer>

The (optional) health check settings.

Digital Ocean Documentation.

pub fn sticky_sessions<S: AsRef<str> + Display + Serialize>( self, kind: S, cookie_name: Option<S>, cookie_ttl_seconds: Option<usize>, ) -> LoadBalancerRequest<Update, LoadBalancer>

The (optional) sticky sessions settings. kind must be cookies or none. If kind is cookies then cookie_name and cookie_ttl_seconds should be set as well.

Digital Ocean Documentation.

pub fn redirect_http_to_https( self, setting: bool, ) -> LoadBalancerRequest<Update, LoadBalancer>

A boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.

Digital Ocean Documentation.

pub fn droplets( self, ids: Vec<usize>, ) -> LoadBalancerRequest<Update, LoadBalancer>

The IDs of the Droplets to be assigned to the Load Balancer.

Note: Not intended to be used alongside the tag function.

Digital Ocean Documentation.

pub fn tag<S>(self, tag: S) -> LoadBalancerRequest<Update, LoadBalancer>

where S: AsRef<str> + Display + Serialize,

The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.

Note: Not intended to be used alongside the droplets function.

Digital Ocean Documentation.

impl Request<Get, LoadBalancer>

pub fn add_droplets(self, ids: Vec<usize>) -> LoadBalancerRequest<Create, ()>

Add droplets (by id) to the load balancer.

Digital Ocean Documentation.

pub fn remove_droplets(self, ids: Vec<usize>) -> LoadBalancerRequest<Delete, ()>

Remove droplets (by id) from the load balancer.

Digital Ocean Documentation.

pub fn add_forwarding_rules<T>( self, items: Vec<T>, ) -> LoadBalancerRequest<Create, ()>

where T: Into<ForwardingRule>,

Add a forwarding rule to the Load Balancer.

Digital Ocean Documentation.

pub fn remove_forwarding_rules<T>( self, items: Vec<T>, ) -> LoadBalancerRequest<Delete, ()>

where T: Into<ForwardingRule>,

Remove a forwarding rule to the Load Balancer.

Digital Ocean Documentation.

impl Request<Update, SshKey>

pub fn name<S: AsRef<str> + Display + Serialize>(self, val: S) -> Self

The name to give the new SSH key in your account.

Digital Ocean Documentation.

impl Request<Get, Tag>

pub fn add_resources<S>(self, resources: Vec<(S, S)>) -> TagRequest<Create, ()>

where S: AsRef<str> + Serialize + Display,

Accepts tuples matching (id, type). Currently the only type is "droplet".

Digital Ocean Documentation.

pub fn remove_resources<S>( self, resources: Vec<(S, S)>, ) -> TagRequest<Delete, ()>

where S: AsRef<str> + Serialize + Display,

Accepts tuples matching (id, type). Currently the only type is "droplet".

Digital Ocean Documentation.

impl Request<List, Vec<Volume>>

pub fn region<S: AsRef<str> + Serialize + Display>(self, region: S) -> Self

Digital Ocean Documentation.

impl Request<Get, Volume>

pub fn snapshots(self) -> SnapshotRequest<List, Vec<Snapshot>>

Digital Ocean Documentation.

pub fn snapshot<S>(self, name: S) -> SnapshotRequest<Create, Snapshot>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

impl Request<Create, Volume>

pub fn description<S: AsRef<str> + Serialize + Display>(self, val: S) -> Self

An optional free-form text field to describe a Block Storage volume.

Digital Ocean Documentation.

pub fn region<S: AsRef<str> + Serialize + Display>(self, val: S) -> Self

The region where the Block Storage volume will be created. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.

Note: Should not be specified with a snapshot_id.

Digital Ocean Documentation.

pub fn snapshot_id<S: AsRef<str> + Serialize + Display>(self, val: S) -> Self

The unique identifier for the volume snapshot from which to create the volume.

Note: Should not be specified with a region_id.

Digital Ocean Documentation.

impl Request<Get, Volume>

pub fn attach(self, droplet: usize) -> VolumeActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn detach(self, droplet: usize) -> VolumeActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn resize(self, size: usize) -> VolumeActionRequest<Create, Action>

Digital Ocean Documentation.

pub fn actions(self) -> VolumeActionRequest<List, Vec<Action>>

Digital Ocean Documentation.

pub fn action(self, id: usize) -> VolumeActionRequest<Get, Action>

Digital Ocean Documentation.

impl<A: Method, R> Request<A, R>

pub fn url_mut(&mut self) -> &mut Url

pub fn body_mut(&mut self) -> &mut Value

The JSON body of the request.

impl<A: Method, R> Request<A, R>

pub fn url(&self) -> &Url

pub fn body(&self) -> &Value

The JSON body of the request.

pub fn method(&self) -> &A

impl<A: Method, R> Request<A, R>

pub fn set_url(&mut self, val: Url) -> &mut Self

pub fn set_body(&mut self, val: Value) -> &mut Self

The JSON body of the request.

impl<A: Method, V> Request<A, V>

pub fn new(url: Url) -> Self

Create a request pointing at the given url. V is the value ultimately returned when the call is executed.

impl<V> Request<List, V>

pub fn limit(self, limit: Option<usize>) -> Self

Impose a limit on the number of values which may be retrieved from a request.

Trait Implementations

impl<A: Clone + Method, R: Clone> Clone for Request<A, R>

fn clone(&self) -> Request<A, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Method, R: Debug> Debug for Request<A, R>

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

Formats the value using the given formatter.

impl<'de, A, R> Deserialize<'de> for Request<A, R>

where A: Deserialize<'de> + Method,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Executable<()> for Request<Delete, ()>

fn execute<'life0, 'async_trait>( self, instance: &'life0 DigitalOcean, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the corresponding call.

impl<V: HasResponse + Send> Executable<V> for Request<Create, V>

fn execute<'life0, 'async_trait>( self, instance: &'life0 DigitalOcean, ) -> Pin<Box<dyn Future<Output = Result<V, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the corresponding call.

impl<V: HasResponse + Send> Executable<V> for Request<Get, V>

fn execute<'life0, 'async_trait>( self, instance: &'life0 DigitalOcean, ) -> Pin<Box<dyn Future<Output = Result<V, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the corresponding call.

impl<V: HasResponse + Send> Executable<V> for Request<Update, V>

fn execute<'life0, 'async_trait>( self, instance: &'life0 DigitalOcean, ) -> Pin<Box<dyn Future<Output = Result<V, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the corresponding call.

impl<V> Executable<Vec<V>> for Request<List, Vec<V>>

where Vec<V>: HasResponse, <Vec<V> as HasResponse>::Response: HasPagination, V: Send,

fn execute<'life0, 'async_trait>( self, instance: &'life0 DigitalOcean, ) -> Pin<Box<dyn Future<Output = Result<Vec<V>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the corresponding call.