Struct seaplane_cli::api::FormationsReq

pub struct FormationsReq { /* private fields */ }

Wraps an SDK FormationsRequest where we do additional things like re-use request access tokens, allow changing the Formation this request is pointed to, and map errors appropriately.

Implementations

impl FormationsReq

pub fn new<S: Into<String>>(ctx: &Ctx, name: Option<S>) -> Result<Self>

Builds a FormationsRequest and immediately requests an access token using the given API key.

If the name is None it should be noted that the only request that can be made without error is FormationsRequest::list_names

pub fn new_delay_token(ctx: &Ctx) -> Result<Self>

Builds a FormationsRequest but does not request an access token using the given API key.

You must call refresh_token to have the access token requested.

pub fn refresh_token(&mut self) -> Result<()>

Request a new Access Token

pub fn token_or_refresh(&mut self) -> Result<&str>

Retrieves the JWT access token, requesting a new one if required.

pub fn set_name<S: Into<String>>(&mut self, name: S) -> Result<()>

Sets the Formation name and re-builds the inner FormationsRequest also requesting a new access token if required

pub fn get_all_formations<S: AsRef<str>>(
    &mut self,
    formation_names: &[S],
    pb: &Pb
) -> Result<Formations>

Retrieves all Formations and their Formation Configurations (both active and inactive) from the Compute API. Makes multiple calls against the API to gather the info and returns a Formations struct.

It should be noted that the local IDs associated with all the items in the Formations struct are generated unique after retrieval from the compute API. i.e. they do not match anything existing in the local DB even if the contents are otherwise identical.

pub fn get_formation_names(&mut self) -> Result<Vec<String>>

Return a Vec of all known formation names if this FormationsReq currently has no name associated with it. Otherwise it returns the single name associated with this FormationsReq (returned in a Vec). This is used when the CLI supports either doing something to all formations, or just a single one that is passed in by the user.

impl FormationsReq

pub fn list_names(&mut self) -> Result<FormationNamesModel>

pub fn get_metadata(&mut self) -> Result<FormationMetadataModel>

pub fn create(
    &mut self,
    configuration: &FormationConfigurationModel,
    active: bool
) -> Result<Vec<Uuid>>

pub fn clone_from(&mut self, source_name: &str, active: bool) -> Result<Vec<Uuid>>

pub fn delete(&mut self, force: bool) -> Result<Vec<Uuid>>

pub fn get_active_configurations(&mut self) -> Result<ActiveConfigurationsModel>

pub fn stop(&mut self) -> Result<()>

pub fn set_active_configurations(
    &mut self,
    configs: &ActiveConfigurationsModel,
    force: bool
) -> Result<()>

pub fn get_containers(&mut self) -> Result<ContainersModel>

pub fn get_container(&mut self, container_id: Uuid) -> Result<ContainerModel>

pub fn get_configuration(
    &mut self,
    uuid: Uuid
) -> Result<FormationConfigurationModel>

pub fn list_configuration_ids(&mut self) -> Result<Vec<Uuid>>

pub fn remove_configuration(&mut self, uuid: Uuid, force: bool) -> Result<Uuid>

pub fn add_configuration(
    &mut self,
    configuration: &FormationConfigurationModel,
    active: bool
) -> Result<Uuid>

Trait Implementations

impl Debug for FormationsReq

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

Formats the value using the given formatter.