Struct VenClient 

pub struct VenClient<K> { /* private fields */ }

A client for interacting with the data in a specific VEN and the resources contained in the VEN.

Implementations

impl VenClient<BusinessLogic>

pub async fn create_resource<S: Display>( &self, name: S, attributes: Option<Vec<ValuesMap>>, targets: Vec<Target>, ) -> Result<ResourceClient<BusinessLogic>, Error>

Create a resource as a child of this VEN

impl VenClient<VirtualEndNode>

pub async fn create_resource<S: Display>( &self, name: S, attributes: Option<Vec<ValuesMap>>, ) -> Result<ResourceClient<VirtualEndNode>, Error>

Create a resource as a child of this VEN

impl<K: ClientKind> VenClient<K>

pub fn id(&self) -> &VenId

Get the VEN ID

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

Get the time the VEN was created on the VTN

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

Get the time the VEN was last modified on the VTN

pub fn content(&self) -> &BlVenRequest

Read the content of the VEN

pub fn content_mut(&mut self) -> &mut BlVenRequest

Modify the content of the VEN. Make sure to call update after your modifications to store them on the VTN.

pub async fn update(&mut self) -> Result<(), Error>

Stores any modifications made to the VEN content at the VTN and refreshes the data stored locally with the returned VTN data

pub async fn delete(self) -> Result<Ven, Error>

Delete the VEN from the VTN.

Depending on the VTN implementation, you may need to delete all associated resources before you can delete the VEN

pub async fn get_all_resources( &self, resource_name: Option<&str>, ) -> Result<Vec<ResourceClient<K>>, Error>

Get all resources stored as children of this VEN.

The client automatically tries to iterate pages where necessary.

pub async fn get_resource_by_id( &self, id: &ResourceId, ) -> Result<ResourceClient<K>, Error>

Get a resource by its ID

pub async fn get_resource_by_name( &self, name: &str, ) -> Result<ResourceClient<K>, Error>

Get VEN by name from VTN. According to the spec, a resource_name must be unique per VEN.

Trait Implementations

impl<K: Clone> Clone for VenClient<K>

fn clone(&self) -> VenClient<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for VenClient<K>

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

Formats the value using the given formatter.