#[non_exhaustive]pub struct DescribeDashboardDefinitionOutputBuilder { /* private fields */ }Expand description
A builder for DescribeDashboardDefinitionOutput.
Implementations§
Source§impl DescribeDashboardDefinitionOutputBuilder
impl DescribeDashboardDefinitionOutputBuilder
Sourcepub fn dashboard_id(self, input: impl Into<String>) -> Self
pub fn dashboard_id(self, input: impl Into<String>) -> Self
The ID of the dashboard described.
Sourcepub fn set_dashboard_id(self, input: Option<String>) -> Self
pub fn set_dashboard_id(self, input: Option<String>) -> Self
The ID of the dashboard described.
Sourcepub fn get_dashboard_id(&self) -> &Option<String>
pub fn get_dashboard_id(&self) -> &Option<String>
The ID of the dashboard described.
Sourcepub fn errors(self, input: DashboardError) -> Self
pub fn errors(self, input: DashboardError) -> Self
Appends an item to errors.
To override the contents of this collection use set_errors.
Errors associated with this dashboard version.
Sourcepub fn set_errors(self, input: Option<Vec<DashboardError>>) -> Self
pub fn set_errors(self, input: Option<Vec<DashboardError>>) -> Self
Errors associated with this dashboard version.
Sourcepub fn get_errors(&self) -> &Option<Vec<DashboardError>>
pub fn get_errors(&self) -> &Option<Vec<DashboardError>>
Errors associated with this dashboard version.
Sourcepub fn resource_status(self, input: ResourceStatus) -> Self
pub fn resource_status(self, input: ResourceStatus) -> Self
Status associated with the dashboard version.
-
CREATION_IN_PROGRESS -
CREATION_SUCCESSFUL -
CREATION_FAILED -
UPDATE_IN_PROGRESS -
UPDATE_SUCCESSFUL -
UPDATE_FAILED -
DELETED
Sourcepub fn set_resource_status(self, input: Option<ResourceStatus>) -> Self
pub fn set_resource_status(self, input: Option<ResourceStatus>) -> Self
Status associated with the dashboard version.
-
CREATION_IN_PROGRESS -
CREATION_SUCCESSFUL -
CREATION_FAILED -
UPDATE_IN_PROGRESS -
UPDATE_SUCCESSFUL -
UPDATE_FAILED -
DELETED
Sourcepub fn get_resource_status(&self) -> &Option<ResourceStatus>
pub fn get_resource_status(&self) -> &Option<ResourceStatus>
Status associated with the dashboard version.
-
CREATION_IN_PROGRESS -
CREATION_SUCCESSFUL -
CREATION_FAILED -
UPDATE_IN_PROGRESS -
UPDATE_SUCCESSFUL -
UPDATE_FAILED -
DELETED
Sourcepub fn theme_arn(self, input: impl Into<String>) -> Self
pub fn theme_arn(self, input: impl Into<String>) -> Self
The ARN of the theme of the dashboard.
Sourcepub fn set_theme_arn(self, input: Option<String>) -> Self
pub fn set_theme_arn(self, input: Option<String>) -> Self
The ARN of the theme of the dashboard.
Sourcepub fn get_theme_arn(&self) -> &Option<String>
pub fn get_theme_arn(&self) -> &Option<String>
The ARN of the theme of the dashboard.
Sourcepub fn definition(self, input: DashboardVersionDefinition) -> Self
pub fn definition(self, input: DashboardVersionDefinition) -> Self
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Sourcepub fn set_definition(self, input: Option<DashboardVersionDefinition>) -> Self
pub fn set_definition(self, input: Option<DashboardVersionDefinition>) -> Self
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Sourcepub fn get_definition(&self) -> &Option<DashboardVersionDefinition>
pub fn get_definition(&self) -> &Option<DashboardVersionDefinition>
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Sourcepub fn set_status(self, input: Option<i32>) -> Self
pub fn set_status(self, input: Option<i32>) -> Self
The HTTP status of the request.
Sourcepub fn get_status(&self) -> &Option<i32>
pub fn get_status(&self) -> &Option<i32>
The HTTP status of the request.
Sourcepub fn request_id(self, input: impl Into<String>) -> Self
pub fn request_id(self, input: impl Into<String>) -> Self
The Amazon Web Services request ID for this operation.
Sourcepub fn set_request_id(self, input: Option<String>) -> Self
pub fn set_request_id(self, input: Option<String>) -> Self
The Amazon Web Services request ID for this operation.
Sourcepub fn get_request_id(&self) -> &Option<String>
pub fn get_request_id(&self) -> &Option<String>
The Amazon Web Services request ID for this operation.
Sourcepub fn dashboard_publish_options(self, input: DashboardPublishOptions) -> Self
pub fn dashboard_publish_options(self, input: DashboardPublishOptions) -> Self
Options for publishing the dashboard:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. When this is set toDISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. This option isCOLLAPSEDby default. -
AvailabilityStatusforQuickSuiteActionsOption- This status can be eitherENABLEDorDISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set toDISABLED. This option isDISABLEDby default. -
AvailabilityStatusforExecutiveSummaryOption- This status can be eitherENABLEDorDISABLED. The option to build an executive summary is disabled when this is set toDISABLED. This option isENABLEDby default. -
AvailabilityStatusforDataStoriesSharingOption- This status can be eitherENABLEDorDISABLED. The option to share a data story is disabled when this is set toDISABLED. This option isENABLEDby default.
Sourcepub fn set_dashboard_publish_options(
self,
input: Option<DashboardPublishOptions>,
) -> Self
pub fn set_dashboard_publish_options( self, input: Option<DashboardPublishOptions>, ) -> Self
Options for publishing the dashboard:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. When this is set toDISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. This option isCOLLAPSEDby default. -
AvailabilityStatusforQuickSuiteActionsOption- This status can be eitherENABLEDorDISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set toDISABLED. This option isDISABLEDby default. -
AvailabilityStatusforExecutiveSummaryOption- This status can be eitherENABLEDorDISABLED. The option to build an executive summary is disabled when this is set toDISABLED. This option isENABLEDby default. -
AvailabilityStatusforDataStoriesSharingOption- This status can be eitherENABLEDorDISABLED. The option to share a data story is disabled when this is set toDISABLED. This option isENABLEDby default.
Sourcepub fn get_dashboard_publish_options(&self) -> &Option<DashboardPublishOptions>
pub fn get_dashboard_publish_options(&self) -> &Option<DashboardPublishOptions>
Options for publishing the dashboard:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. When this is set toDISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. This option isCOLLAPSEDby default. -
AvailabilityStatusforQuickSuiteActionsOption- This status can be eitherENABLEDorDISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set toDISABLED. This option isDISABLEDby default. -
AvailabilityStatusforExecutiveSummaryOption- This status can be eitherENABLEDorDISABLED. The option to build an executive summary is disabled when this is set toDISABLED. This option isENABLEDby default. -
AvailabilityStatusforDataStoriesSharingOption- This status can be eitherENABLEDorDISABLED. The option to share a data story is disabled when this is set toDISABLED. This option isENABLEDby default.
Sourcepub fn build(self) -> DescribeDashboardDefinitionOutput
pub fn build(self) -> DescribeDashboardDefinitionOutput
Consumes the builder and constructs a DescribeDashboardDefinitionOutput.
Trait Implementations§
Source§impl Clone for DescribeDashboardDefinitionOutputBuilder
impl Clone for DescribeDashboardDefinitionOutputBuilder
Source§fn clone(&self) -> DescribeDashboardDefinitionOutputBuilder
fn clone(&self) -> DescribeDashboardDefinitionOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for DescribeDashboardDefinitionOutputBuilder
impl Default for DescribeDashboardDefinitionOutputBuilder
Source§fn default() -> DescribeDashboardDefinitionOutputBuilder
fn default() -> DescribeDashboardDefinitionOutputBuilder
Source§impl PartialEq for DescribeDashboardDefinitionOutputBuilder
impl PartialEq for DescribeDashboardDefinitionOutputBuilder
Source§fn eq(&self, other: &DescribeDashboardDefinitionOutputBuilder) -> bool
fn eq(&self, other: &DescribeDashboardDefinitionOutputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for DescribeDashboardDefinitionOutputBuilder
Auto Trait Implementations§
impl Freeze for DescribeDashboardDefinitionOutputBuilder
impl RefUnwindSafe for DescribeDashboardDefinitionOutputBuilder
impl Send for DescribeDashboardDefinitionOutputBuilder
impl Sync for DescribeDashboardDefinitionOutputBuilder
impl Unpin for DescribeDashboardDefinitionOutputBuilder
impl UnwindSafe for DescribeDashboardDefinitionOutputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);