Struct Parameter

#[non_exhaustive]
pub struct Parameter {
    pub parameter_name: Option<String>,
    pub parameter_type: Option<ParameterType>,
    pub parameter_value: Option<String>,
    pub node_type_specific_values: Option<Vec<NodeTypeSpecificValue>>,
    pub description: Option<String>,
    pub source: Option<String>,
    pub data_type: Option<String>,
    pub allowed_values: Option<String>,
    pub is_modifiable: Option<IsModifiable>,
    pub change_type: Option<ChangeType>,
}

Describes an individual setting that controls some aspect of DAX behavior.

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.

parameter_name: Option<String>

The name of the parameter.

parameter_type: Option<ParameterType>

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

parameter_value: Option<String>

The value for the parameter.

node_type_specific_values: Option<Vec<NodeTypeSpecificValue>>

A list of node types, and specific parameter values for each node.

description: Option<String>

A description of the parameter

source: Option<String>

How the parameter is defined. For example, system denotes a system-defined parameter.

data_type: Option<String>

The data type of the parameter. For example, integer:

allowed_values: Option<String>

A range of values within which the parameter can be set.

is_modifiable: Option<IsModifiable>

Whether the customer is allowed to modify the parameter.

change_type: Option<ChangeType>

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

Implementations

impl Parameter

pub fn parameter_name(&self) -> Option<&str>

The name of the parameter.

pub fn parameter_type(&self) -> Option<&ParameterType>

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

pub fn parameter_value(&self) -> Option<&str>

The value for the parameter.

pub fn node_type_specific_values(&self) -> &[NodeTypeSpecificValue]

A list of node types, and specific parameter values for each node.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .node_type_specific_values.is_none().

pub fn description(&self) -> Option<&str>

A description of the parameter

pub fn source(&self) -> Option<&str>

How the parameter is defined. For example, system denotes a system-defined parameter.

pub fn data_type(&self) -> Option<&str>

The data type of the parameter. For example, integer:

pub fn allowed_values(&self) -> Option<&str>

A range of values within which the parameter can be set.

pub fn is_modifiable(&self) -> Option<&IsModifiable>

Whether the customer is allowed to modify the parameter.

pub fn change_type(&self) -> Option<&ChangeType>

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

impl Parameter

pub fn builder() -> ParameterBuilder

Creates a new builder-style object to manufacture Parameter.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl PartialEq for Parameter

fn eq(&self, other: &Parameter) -> 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 Parameter