Struct ConfigurationStore

pub struct ConfigurationStore { /* private fields */ }

Represents the store of gcloud configurations

Implementations

impl ConfigurationStore

pub fn with_default_location() -> Result<Self>

Opens the configuration store using the OS-specific defaults

If the CLOUDSDK_CONFIG environment variable is set then this will be used, otherwise an OS-specific default location will be used, as defined by the dirs crate, e.g.:

• Windows: %APPDATA%\gcloud
• Linux: ~/.config/gcloud
• Mac: ~/.config/gcloud - note that this does not follow the Apple Developer Guidelines

pub fn with_location(gcloud_path: PathBuf) -> Result<Self>

Opens a configuration store at the given path

pub fn active(&self) -> &str

Get the name of the currently active configuration

pub fn configurations(&self) -> Vec<&Configuration>

Get the collection of currently available configurations

pub fn is_active(&self, configuration: &Configuration) -> bool

Check if the given configuration is active

pub fn activate(&mut self, name: &str) -> Result<()>

Activate a configuration by name

pub fn copy( &mut self, src_name: &str, dest_name: &str, conflict: ConflictAction, ) -> Result<()>

Copy an existing configuration, preserving all properties

pub fn create( &mut self, name: &str, properties: &Properties, conflict: ConflictAction, ) -> Result<()>

Create a new configuration

pub fn delete(&mut self, name: &str) -> Result<()>

Delete a configuration

pub fn describe(&self, name: &str) -> Result<Properties>

Describe the properties in the given configuration

pub fn rename( &mut self, old_name: &str, new_name: &str, conflict: ConflictAction, ) -> Result<()>

Rename a configuration

pub fn find_by_name(&self, name: &str) -> Option<&Configuration>

Find a configuration by name

Trait Implementations

impl Debug for ConfigurationStore

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

Formats the value using the given formatter.