Struct DatasetParameter

#[non_exhaustive]
pub struct DatasetParameter {
    pub name: String,
    pub type: ParameterType,
    pub datetime_options: Option<DatetimeOptions>,
    pub create_column: bool,
    pub filter: Option<FilterExpression>,
}

Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

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

The name of the parameter that is used in the dataset's Amazon S3 path.

type: ParameterType

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

datetime_options: Option<DatetimeOptions>

Additional parameter options such as a format and a timezone. Required for datetime parameters.

create_column: bool

Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

filter: Option<FilterExpression>

The optional filter expression structure to apply additional matching criteria to the parameter.

Implementations

impl DatasetParameter

pub fn name(&self) -> &str

The name of the parameter that is used in the dataset's Amazon S3 path.

pub fn type(&self) -> &ParameterType

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

pub fn datetime_options(&self) -> Option<&DatetimeOptions>

Additional parameter options such as a format and a timezone. Required for datetime parameters.

pub fn create_column(&self) -> bool

Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

pub fn filter(&self) -> Option<&FilterExpression>

The optional filter expression structure to apply additional matching criteria to the parameter.

impl DatasetParameter

pub fn builder() -> DatasetParameterBuilder

Creates a new builder-style object to manufacture DatasetParameter.

Trait Implementations

impl Clone for DatasetParameter

fn clone(&self) -> DatasetParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatasetParameter

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

Formats the value using the given formatter.

impl PartialEq for DatasetParameter

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