Struct CreateVariable 

pub struct CreateVariable {
    pub path: String,
    pub value: String,
    pub is_secret: bool,
    pub description: String,
    pub account: Option<i32>,
    pub is_oauth: Option<bool>,
    pub expires_at: Option<String>,
    pub value_valid_until: Option<String>,
    pub labels: Option<Vec<String>>,
    pub ws_specific: Option<bool>,
}

Fields

path: String

The path to the variable

value: String

The value of the variable. For a secret, $external:vault://<path>#<key> stores a reference to an existing secret in the instance’s external HashiCorp Vault (path as vault kv get takes it) instead of a value; without #<key> it reads the whole secret as a JSON object of its fields. It is resolved on each read, only under the path prefixes a superadmin allowed for the workspace, and is returned as-is when the secret is not decrypted.

is_secret: bool

Whether the variable is a secret

description: String

The description of the variable

account: Option<i32>

Ignored. A variable is linked to an OAuth account only when createAccount creates both.

is_oauth: Option<bool>

Whether the variable is an OAuth variable

expires_at: Option<String>

When to garbage-collect the variable. Used for ephemeral secrets; the variable is deleted once this is reached. Not the value’s expiry — see value_valid_until.

value_valid_until: Option<String>

When the value stored in this variable stops working. Triggers the workspace’s variable expiration handler ahead of it, by the handler’s notify_before_secs (1 day by default); never causes the variable to be deleted.

labels: Option<Vec<String>>

ws_specific: Option<bool>

Implementations

impl CreateVariable

pub fn new( path: String, value: String, is_secret: bool, description: String, ) -> CreateVariable

Trait Implementations

impl Clone for CreateVariable

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateVariable

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

Formats the value using the given formatter.

impl Default for CreateVariable

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateVariable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateVariable

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CreateVariable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateVariable