Struct ParameterSpec 

#[non_exhaustive]
pub struct ParameterSpec {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub is_required: bool,
    pub value_type: ValueType,
    pub default_value: Option<ParamValue>,
    pub substitution_rules: Vec<ParameterSubstitutionRule>,
    pub sub_parameters: Vec<ParameterSpec>,
    pub validation: Option<Validation>,
    /* private fields */
}

The parameter specification for the cloud control.

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.

name: String

Required. The name of the parameter.

display_name: String

Optional. The friendly name of the parameter. The maximum length is 200 characters.

description: String

Optional. The description of the parameter. The maximum length is 2000 characters.

is_required: bool

Required. Whether the parameter is required.

value_type: ValueType

Required. The parameter value type.

default_value: Option<ParamValue>

Optional. The default value of the parameter.

substitution_rules: Vec<ParameterSubstitutionRule>

Optional. The list of parameter substitutions.

sub_parameters: Vec<ParameterSpec>

Optional. The parameter specification for oneOf attributes.

validation: Option<Validation>

Optional. The permitted set of values for the parameter.

Implementations

impl ParameterSpec

pub fn new() -> Self

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

Sets the value of name.

Example

let x = ParameterSpec::new().set_name("example");

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

Sets the value of display_name.

Example

let x = ParameterSpec::new().set_display_name("example");

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

Sets the value of description.

Example

let x = ParameterSpec::new().set_description("example");

pub fn set_is_required<T: Into<bool>>(self, v: T) -> Self

Sets the value of is_required.

Example

let x = ParameterSpec::new().set_is_required(true);

pub fn set_value_type<T: Into<ValueType>>(self, v: T) -> Self

Sets the value of value_type.

Example

use google_cloud_cloudsecuritycompliance_v1::model::parameter_spec::ValueType;
let x0 = ParameterSpec::new().set_value_type(ValueType::String);
let x1 = ParameterSpec::new().set_value_type(ValueType::Boolean);
let x2 = ParameterSpec::new().set_value_type(ValueType::Stringlist);

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

where T: Into<ParamValue>,

Sets the value of default_value.

Example

use google_cloud_cloudsecuritycompliance_v1::model::ParamValue;
let x = ParameterSpec::new().set_default_value(ParamValue::default()/* use setters */);

pub fn set_or_clear_default_value<T>(self, v: Option<T>) -> Self

where T: Into<ParamValue>,

Sets or clears the value of default_value.

Example

use google_cloud_cloudsecuritycompliance_v1::model::ParamValue;
let x = ParameterSpec::new().set_or_clear_default_value(Some(ParamValue::default()/* use setters */));
let x = ParameterSpec::new().set_or_clear_default_value(None::<ParamValue>);

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

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

Sets the value of substitution_rules.

Example

use google_cloud_cloudsecuritycompliance_v1::model::ParameterSubstitutionRule;
let x = ParameterSpec::new()
    .set_substitution_rules([
        ParameterSubstitutionRule::default()/* use setters */,
        ParameterSubstitutionRule::default()/* use (different) setters */,
    ]);

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

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

Sets the value of sub_parameters.

Example

let x = ParameterSpec::new()
    .set_sub_parameters([
        ParameterSpec::default()/* use setters */,
        ParameterSpec::default()/* use (different) setters */,
    ]);

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

where T: Into<Validation>,

Sets the value of validation.

Example

use google_cloud_cloudsecuritycompliance_v1::model::Validation;
let x = ParameterSpec::new().set_validation(Validation::default()/* use setters */);

pub fn set_or_clear_validation<T>(self, v: Option<T>) -> Self

where T: Into<Validation>,

Sets or clears the value of validation.

Example

use google_cloud_cloudsecuritycompliance_v1::model::Validation;
let x = ParameterSpec::new().set_or_clear_validation(Some(Validation::default()/* use setters */));
let x = ParameterSpec::new().set_or_clear_validation(None::<Validation>);

Trait Implementations

impl Clone for ParameterSpec

fn clone(&self) -> ParameterSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterSpec

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

Formats the value using the given formatter.

impl Default for ParameterSpec

fn default() -> ParameterSpec

Returns the “default value” for a type.

impl Message for ParameterSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ParameterSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParameterSpec