Struct aws_sdk_quicksight::types::builders::SheetDefinitionBuilder

#[non_exhaustive]
pub struct SheetDefinitionBuilder { /* private fields */ }

A builder for SheetDefinition.

Implementations

impl SheetDefinitionBuilder

pub fn sheet_id(self, input: impl Into<String>) -> Self

The unique identifier of a sheet.

This field is required.

pub fn set_sheet_id(self, input: Option<String>) -> Self

The unique identifier of a sheet.

pub fn get_sheet_id(&self) -> &Option<String>

The unique identifier of a sheet.

pub fn title(self, input: impl Into<String>) -> Self

The title of the sheet.

pub fn set_title(self, input: Option<String>) -> Self

The title of the sheet.

pub fn get_title(&self) -> &Option<String>

The title of the sheet.

pub fn description(self, input: impl Into<String>) -> Self

A description of the sheet.

pub fn set_description(self, input: Option<String>) -> Self

A description of the sheet.

pub fn get_description(&self) -> &Option<String>

A description of the sheet.

pub fn name(self, input: impl Into<String>) -> Self

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

pub fn set_name(self, input: Option<String>) -> Self

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

pub fn get_name(&self) -> &Option<String>

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

pub fn parameter_controls(self, input: ParameterControl) -> Self

Appends an item to parameter_controls.

To override the contents of this collection use set_parameter_controls.

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

pub fn set_parameter_controls( self, input: Option<Vec<ParameterControl>> ) -> Self

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

pub fn get_parameter_controls(&self) -> &Option<Vec<ParameterControl>>

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

pub fn filter_controls(self, input: FilterControl) -> Self

Appends an item to filter_controls.

To override the contents of this collection use set_filter_controls.

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

pub fn set_filter_controls(self, input: Option<Vec<FilterControl>>) -> Self

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

pub fn get_filter_controls(&self) -> &Option<Vec<FilterControl>>

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

pub fn visuals(self, input: Visual) -> Self

Appends an item to visuals.

To override the contents of this collection use set_visuals.

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

pub fn set_visuals(self, input: Option<Vec<Visual>>) -> Self

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

pub fn get_visuals(&self) -> &Option<Vec<Visual>>

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

pub fn text_boxes(self, input: SheetTextBox) -> Self

Appends an item to text_boxes.

To override the contents of this collection use set_text_boxes.

The text boxes that are on a sheet.

pub fn set_text_boxes(self, input: Option<Vec<SheetTextBox>>) -> Self

The text boxes that are on a sheet.

pub fn get_text_boxes(&self) -> &Option<Vec<SheetTextBox>>

The text boxes that are on a sheet.

pub fn layouts(self, input: Layout) -> Self

Appends an item to layouts.

To override the contents of this collection use set_layouts.

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

pub fn set_layouts(self, input: Option<Vec<Layout>>) -> Self

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

pub fn get_layouts(&self) -> &Option<Vec<Layout>>

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

pub fn sheet_control_layouts(self, input: SheetControlLayout) -> Self

Appends an item to sheet_control_layouts.

To override the contents of this collection use set_sheet_control_layouts.

The control layouts of the sheet.

pub fn set_sheet_control_layouts( self, input: Option<Vec<SheetControlLayout>> ) -> Self

The control layouts of the sheet.

pub fn get_sheet_control_layouts(&self) -> &Option<Vec<SheetControlLayout>>

The control layouts of the sheet.

pub fn content_type(self, input: SheetContentType) -> Self

The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

pub fn set_content_type(self, input: Option<SheetContentType>) -> Self

The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

pub fn get_content_type(&self) -> &Option<SheetContentType>

The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

pub fn build(self) -> Result<SheetDefinition, BuildError>

Consumes the builder and constructs a SheetDefinition. This method will fail if any of the following fields are not set:

• sheet_id

Trait Implementations

impl Clone for SheetDefinitionBuilder

fn clone(&self) -> SheetDefinitionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SheetDefinitionBuilder

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

Formats the value using the given formatter.

impl Default for SheetDefinitionBuilder

fn default() -> SheetDefinitionBuilder

Returns the “default value” for a type.

impl PartialEq for SheetDefinitionBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SheetDefinitionBuilder