Struct gcp_client::google::cloud::osconfig::agentendpoint::v1beta::SoftwareRecipe

pub struct SoftwareRecipe {
    pub name: String,
    pub version: String,
    pub artifacts: Vec<Artifact>,
    pub install_steps: Vec<Step>,
    pub update_steps: Vec<Step>,
    pub desired_state: i32,
}

A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software.

Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package.

Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell.

Updating a software recipe

If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is INSTALLED_KEEP_UPDATED, then the recipe is updated to the new version.

Script Working Directories

Each script or execution step is run in its own temporary directory which is deleted after completing the step.

Fields

name: String

Unique identifier for the recipe. Only one recipe with a given name is installed on an instance.

Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments.

version: String

The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78).

artifacts: Vec<Artifact>

Resources available to be used in the steps in the recipe.

install_steps: Vec<Step>

Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. Install steps must be specified and are used on first installation.

update_steps: Vec<Step>

Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. Upgrade steps are not mandatory and are only used when upgrading.

desired_state: i32

Default is INSTALLED. The desired state the agent should maintain for this recipe.

INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected.

Implementations

impl SoftwareRecipe

pub fn desired_state(&self) -> DesiredState

Returns the enum value of desired_state, or the default if the field is set to an invalid enum value.

pub fn set_desired_state(&mut self, value: DesiredState)

Sets desired_state to the provided enum value.

Trait Implementations

impl Clone for SoftwareRecipe

fn clone(&self) -> SoftwareRecipe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SoftwareRecipe

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

Formats the value using the given formatter.

impl Default for SoftwareRecipe

fn default() -> SoftwareRecipe

Returns the "default value" for a type.

impl Message for SoftwareRecipe

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<SoftwareRecipe> for SoftwareRecipe

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for SoftwareRecipe