Struct Parameter

#[non_exhaustive]
pub struct Parameter {
    pub parameter_name: Option<String>,
    pub parameter_value: Option<String>,
    pub description: Option<String>,
    pub source: Option<String>,
    pub apply_type: Option<String>,
    pub data_type: Option<String>,
    pub allowed_values: Option<String>,
    pub is_modifiable: Option<bool>,
    pub minimum_engine_version: Option<String>,
    pub apply_method: Option<ApplyMethod>,
}

Detailed information about an individual parameter.

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>

Specifies the name of the parameter.

parameter_value: Option<String>

Specifies the value of the parameter.

description: Option<String>

Provides a description of the parameter.

source: Option<String>

Indicates the source of the parameter value.

apply_type: Option<String>

Specifies the engine-specific parameters type.

data_type: Option<String>

Specifies the valid data type for the parameter.

allowed_values: Option<String>

Specifies the valid range of values for the parameter.

is_modifiable: Option<bool>

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimum_engine_version: Option<String>

The earliest engine version to which the parameter can apply.

apply_method: Option<ApplyMethod>

Indicates when to apply parameter updates.

Implementations

impl Parameter

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

Specifies the name of the parameter.

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

Specifies the value of the parameter.

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

Provides a description of the parameter.

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

Indicates the source of the parameter value.

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

Specifies the engine-specific parameters type.

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

Specifies the valid data type for the parameter.

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

Specifies the valid range of values for the parameter.

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

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

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

The earliest engine version to which the parameter can apply.

pub fn apply_method(&self) -> Option<&ApplyMethod>

Indicates when to apply parameter updates.

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 duplicate 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