Struct TemplateVersionDefinition

#[non_exhaustive]
pub struct TemplateVersionDefinition {
    pub data_set_configurations: Vec<DataSetConfiguration>,
    pub sheets: Option<Vec<SheetDefinition>>,
    pub calculated_fields: Option<Vec<CalculatedField>>,
    pub parameter_declarations: Option<Vec<ParameterDeclaration>>,
    pub filter_groups: Option<Vec<FilterGroup>>,
    pub column_configurations: Option<Vec<ColumnConfiguration>>,
    pub analysis_defaults: Option<AnalysisDefaults>,
    pub options: Option<AssetOptions>,
    pub query_execution_options: Option<QueryExecutionOptions>,
    pub static_files: Option<Vec<StaticFile>>,
}

The detailed definition of a template.

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.

data_set_configurations: Vec<DataSetConfiguration>

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

sheets: Option<Vec<SheetDefinition>>

An array of sheet definitions for a template.

calculated_fields: Option<Vec<CalculatedField>>

An array of calculated field definitions for the template.

parameter_declarations: Option<Vec<ParameterDeclaration>>

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

filter_groups: Option<Vec<FilterGroup>>

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

column_configurations: Option<Vec<ColumnConfiguration>>

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

analysis_defaults: Option<AnalysisDefaults>

The configuration for default analysis settings.

options: Option<AssetOptions>

An array of option definitions for a template.

query_execution_options: Option<QueryExecutionOptions>

A structure that describes the query execution options.

static_files: Option<Vec<StaticFile>>

The static files for the definition.

Implementations

impl TemplateVersionDefinition

pub fn data_set_configurations(&self) -> &[DataSetConfiguration]

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

pub fn sheets(&self) -> &[SheetDefinition]

An array of sheet definitions for a template.

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

pub fn calculated_fields(&self) -> &[CalculatedField]

An array of calculated field definitions for the template.

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

pub fn parameter_declarations(&self) -> &[ParameterDeclaration]

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

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

pub fn filter_groups(&self) -> &[FilterGroup]

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

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

pub fn column_configurations(&self) -> &[ColumnConfiguration]

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

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

pub fn analysis_defaults(&self) -> Option<&AnalysisDefaults>

The configuration for default analysis settings.

pub fn options(&self) -> Option<&AssetOptions>

An array of option definitions for a template.

pub fn query_execution_options(&self) -> Option<&QueryExecutionOptions>

A structure that describes the query execution options.

pub fn static_files(&self) -> &[StaticFile]

The static files for the definition.

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

impl TemplateVersionDefinition

pub fn builder() -> TemplateVersionDefinitionBuilder

Creates a new builder-style object to manufacture TemplateVersionDefinition.

Trait Implementations

impl Clone for TemplateVersionDefinition

fn clone(&self) -> TemplateVersionDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateVersionDefinition

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

Formats the value using the given formatter.

impl PartialEq for TemplateVersionDefinition

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