Struct ExecStepConfig 

#[non_exhaustive]
pub struct ExecStepConfig {
    pub allowed_success_codes: Vec<i32>,
    pub interpreter: Interpreter,
    pub executable: Option<Executable>,
    /* private fields */
}

Common configurations for an ExecStep.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allowed_success_codes: Vec<i32>

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

interpreter: Interpreter

The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_(Unix)).

executable: Option<Executable>

Location of the executable.

Implementations

impl ExecStepConfig

pub fn new() -> Self

Creates a new default instance.

pub fn set_allowed_success_codes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<i32>,

Sets the value of allowed_success_codes.

Example

let x = ExecStepConfig::new().set_allowed_success_codes([1, 2, 3]);

pub fn set_interpreter<T: Into<Interpreter>>(self, v: T) -> Self

Sets the value of interpreter.

Example

use google_cloud_osconfig_v1::model::exec_step_config::Interpreter;
let x0 = ExecStepConfig::new().set_interpreter(Interpreter::Shell);
let x1 = ExecStepConfig::new().set_interpreter(Interpreter::Powershell);

pub fn set_executable<T: Into<Option<Executable>>>(self, v: T) -> Self

Sets the value of executable.

Note that all the setters affecting executable are mutually exclusive.

Example

use google_cloud_osconfig_v1::model::exec_step_config::Executable;
let x = ExecStepConfig::new().set_executable(Some(Executable::LocalPath("example".to_string())));

pub fn local_path(&self) -> Option<&String>

The value of executable if it holds a LocalPath, None if the field is not set or holds a different branch.

pub fn set_local_path<T: Into<String>>(self, v: T) -> Self

Sets the value of executable to hold a LocalPath.

Note that all the setters affecting executable are mutually exclusive.

Example

let x = ExecStepConfig::new().set_local_path("example");
assert!(x.local_path().is_some());
assert!(x.gcs_object().is_none());

pub fn gcs_object(&self) -> Option<&Box<GcsObject>>

The value of executable if it holds a GcsObject, None if the field is not set or holds a different branch.

pub fn set_gcs_object<T: Into<Box<GcsObject>>>(self, v: T) -> Self

Sets the value of executable to hold a GcsObject.

Note that all the setters affecting executable are mutually exclusive.

Example

use google_cloud_osconfig_v1::model::GcsObject;
let x = ExecStepConfig::new().set_gcs_object(GcsObject::default()/* use setters */);
assert!(x.gcs_object().is_some());
assert!(x.local_path().is_none());

Trait Implementations

impl Clone for ExecStepConfig

fn clone(&self) -> ExecStepConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecStepConfig

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

Formats the value using the given formatter.

impl Default for ExecStepConfig

fn default() -> ExecStepConfig

Returns the “default value” for a type.

impl Message for ExecStepConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExecStepConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExecStepConfig