/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { /** *

A structure that represents additional options for display * formatting.

See Also:

AWS * API Reference

*/ class DisplayFormatOptions { public: AWS_QUICKSIGHT_API DisplayFormatOptions(); AWS_QUICKSIGHT_API DisplayFormatOptions(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API DisplayFormatOptions& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

A Boolean value that indicates whether to use blank cell format.

*/ inline bool GetUseBlankCellFormat() const{ return m_useBlankCellFormat; } /** *

A Boolean value that indicates whether to use blank cell format.

*/ inline bool UseBlankCellFormatHasBeenSet() const { return m_useBlankCellFormatHasBeenSet; } /** *

A Boolean value that indicates whether to use blank cell format.

*/ inline void SetUseBlankCellFormat(bool value) { m_useBlankCellFormatHasBeenSet = true; m_useBlankCellFormat = value; } /** *

A Boolean value that indicates whether to use blank cell format.

*/ inline DisplayFormatOptions& WithUseBlankCellFormat(bool value) { SetUseBlankCellFormat(value); return *this;} /** *

Determines the blank cell format.

*/ inline const Aws::String& GetBlankCellFormat() const{ return m_blankCellFormat; } /** *

Determines the blank cell format.

*/ inline bool BlankCellFormatHasBeenSet() const { return m_blankCellFormatHasBeenSet; } /** *

Determines the blank cell format.

*/ inline void SetBlankCellFormat(const Aws::String& value) { m_blankCellFormatHasBeenSet = true; m_blankCellFormat = value; } /** *

Determines the blank cell format.

*/ inline void SetBlankCellFormat(Aws::String&& value) { m_blankCellFormatHasBeenSet = true; m_blankCellFormat = std::move(value); } /** *

Determines the blank cell format.

*/ inline void SetBlankCellFormat(const char* value) { m_blankCellFormatHasBeenSet = true; m_blankCellFormat.assign(value); } /** *

Determines the blank cell format.

*/ inline DisplayFormatOptions& WithBlankCellFormat(const Aws::String& value) { SetBlankCellFormat(value); return *this;} /** *

Determines the blank cell format.

*/ inline DisplayFormatOptions& WithBlankCellFormat(Aws::String&& value) { SetBlankCellFormat(std::move(value)); return *this;} /** *

Determines the blank cell format.

*/ inline DisplayFormatOptions& WithBlankCellFormat(const char* value) { SetBlankCellFormat(value); return *this;} /** *

Determines the DateTime format.

*/ inline const Aws::String& GetDateFormat() const{ return m_dateFormat; } /** *

Determines the DateTime format.

*/ inline bool DateFormatHasBeenSet() const { return m_dateFormatHasBeenSet; } /** *

Determines the DateTime format.

*/ inline void SetDateFormat(const Aws::String& value) { m_dateFormatHasBeenSet = true; m_dateFormat = value; } /** *

Determines the DateTime format.

*/ inline void SetDateFormat(Aws::String&& value) { m_dateFormatHasBeenSet = true; m_dateFormat = std::move(value); } /** *

Determines the DateTime format.

*/ inline void SetDateFormat(const char* value) { m_dateFormatHasBeenSet = true; m_dateFormat.assign(value); } /** *

Determines the DateTime format.

*/ inline DisplayFormatOptions& WithDateFormat(const Aws::String& value) { SetDateFormat(value); return *this;} /** *

Determines the DateTime format.

*/ inline DisplayFormatOptions& WithDateFormat(Aws::String&& value) { SetDateFormat(std::move(value)); return *this;} /** *

Determines the DateTime format.

*/ inline DisplayFormatOptions& WithDateFormat(const char* value) { SetDateFormat(value); return *this;} /** *

Determines the decimal separator.

*/ inline const TopicNumericSeparatorSymbol& GetDecimalSeparator() const{ return m_decimalSeparator; } /** *

Determines the decimal separator.

*/ inline bool DecimalSeparatorHasBeenSet() const { return m_decimalSeparatorHasBeenSet; } /** *

Determines the decimal separator.

*/ inline void SetDecimalSeparator(const TopicNumericSeparatorSymbol& value) { m_decimalSeparatorHasBeenSet = true; m_decimalSeparator = value; } /** *

Determines the decimal separator.

*/ inline void SetDecimalSeparator(TopicNumericSeparatorSymbol&& value) { m_decimalSeparatorHasBeenSet = true; m_decimalSeparator = std::move(value); } /** *

Determines the decimal separator.

*/ inline DisplayFormatOptions& WithDecimalSeparator(const TopicNumericSeparatorSymbol& value) { SetDecimalSeparator(value); return *this;} /** *

Determines the decimal separator.

*/ inline DisplayFormatOptions& WithDecimalSeparator(TopicNumericSeparatorSymbol&& value) { SetDecimalSeparator(std::move(value)); return *this;} /** *

Determines the grouping separator.

*/ inline const Aws::String& GetGroupingSeparator() const{ return m_groupingSeparator; } /** *

Determines the grouping separator.

*/ inline bool GroupingSeparatorHasBeenSet() const { return m_groupingSeparatorHasBeenSet; } /** *

Determines the grouping separator.

*/ inline void SetGroupingSeparator(const Aws::String& value) { m_groupingSeparatorHasBeenSet = true; m_groupingSeparator = value; } /** *

Determines the grouping separator.

*/ inline void SetGroupingSeparator(Aws::String&& value) { m_groupingSeparatorHasBeenSet = true; m_groupingSeparator = std::move(value); } /** *

Determines the grouping separator.

*/ inline void SetGroupingSeparator(const char* value) { m_groupingSeparatorHasBeenSet = true; m_groupingSeparator.assign(value); } /** *

Determines the grouping separator.

*/ inline DisplayFormatOptions& WithGroupingSeparator(const Aws::String& value) { SetGroupingSeparator(value); return *this;} /** *

Determines the grouping separator.

*/ inline DisplayFormatOptions& WithGroupingSeparator(Aws::String&& value) { SetGroupingSeparator(std::move(value)); return *this;} /** *

Determines the grouping separator.

*/ inline DisplayFormatOptions& WithGroupingSeparator(const char* value) { SetGroupingSeparator(value); return *this;} /** *

A Boolean value that indicates whether to use grouping.

*/ inline bool GetUseGrouping() const{ return m_useGrouping; } /** *

A Boolean value that indicates whether to use grouping.

*/ inline bool UseGroupingHasBeenSet() const { return m_useGroupingHasBeenSet; } /** *

A Boolean value that indicates whether to use grouping.

*/ inline void SetUseGrouping(bool value) { m_useGroupingHasBeenSet = true; m_useGrouping = value; } /** *

A Boolean value that indicates whether to use grouping.

*/ inline DisplayFormatOptions& WithUseGrouping(bool value) { SetUseGrouping(value); return *this;} /** *

Determines the number of fraction digits.

*/ inline int GetFractionDigits() const{ return m_fractionDigits; } /** *

Determines the number of fraction digits.

*/ inline bool FractionDigitsHasBeenSet() const { return m_fractionDigitsHasBeenSet; } /** *

Determines the number of fraction digits.

*/ inline void SetFractionDigits(int value) { m_fractionDigitsHasBeenSet = true; m_fractionDigits = value; } /** *

Determines the number of fraction digits.

*/ inline DisplayFormatOptions& WithFractionDigits(int value) { SetFractionDigits(value); return *this;} /** *

The prefix value for a display format.

*/ inline const Aws::String& GetPrefix() const{ return m_prefix; } /** *

The prefix value for a display format.

*/ inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; } /** *

The prefix value for a display format.

*/ inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; } /** *

The prefix value for a display format.

*/ inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); } /** *

The prefix value for a display format.

*/ inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); } /** *

The prefix value for a display format.

*/ inline DisplayFormatOptions& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;} /** *

The prefix value for a display format.

*/ inline DisplayFormatOptions& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;} /** *

The prefix value for a display format.

*/ inline DisplayFormatOptions& WithPrefix(const char* value) { SetPrefix(value); return *this;} /** *

The suffix value for a display format.

*/ inline const Aws::String& GetSuffix() const{ return m_suffix; } /** *

The suffix value for a display format.

*/ inline bool SuffixHasBeenSet() const { return m_suffixHasBeenSet; } /** *

The suffix value for a display format.

*/ inline void SetSuffix(const Aws::String& value) { m_suffixHasBeenSet = true; m_suffix = value; } /** *

The suffix value for a display format.

*/ inline void SetSuffix(Aws::String&& value) { m_suffixHasBeenSet = true; m_suffix = std::move(value); } /** *

The suffix value for a display format.

*/ inline void SetSuffix(const char* value) { m_suffixHasBeenSet = true; m_suffix.assign(value); } /** *

The suffix value for a display format.

*/ inline DisplayFormatOptions& WithSuffix(const Aws::String& value) { SetSuffix(value); return *this;} /** *

The suffix value for a display format.

*/ inline DisplayFormatOptions& WithSuffix(Aws::String&& value) { SetSuffix(std::move(value)); return *this;} /** *

The suffix value for a display format.

*/ inline DisplayFormatOptions& WithSuffix(const char* value) { SetSuffix(value); return *this;} /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, and TRILLIONS.

*/ inline const NumberScale& GetUnitScaler() const{ return m_unitScaler; } /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, and TRILLIONS.

*/ inline bool UnitScalerHasBeenSet() const { return m_unitScalerHasBeenSet; } /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, and TRILLIONS.

*/ inline void SetUnitScaler(const NumberScale& value) { m_unitScalerHasBeenSet = true; m_unitScaler = value; } /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, and TRILLIONS.

*/ inline void SetUnitScaler(NumberScale&& value) { m_unitScalerHasBeenSet = true; m_unitScaler = std::move(value); } /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, and TRILLIONS.

*/ inline DisplayFormatOptions& WithUnitScaler(const NumberScale& value) { SetUnitScaler(value); return *this;} /** *

The unit scaler. Valid values for this structure are: NONE, * AUTO, THOUSANDS, MILLIONS, * BILLIONS, and TRILLIONS.

*/ inline DisplayFormatOptions& WithUnitScaler(NumberScale&& value) { SetUnitScaler(std::move(value)); return *this;} /** *

The negative format.

*/ inline const NegativeFormat& GetNegativeFormat() const{ return m_negativeFormat; } /** *

The negative format.

*/ inline bool NegativeFormatHasBeenSet() const { return m_negativeFormatHasBeenSet; } /** *

The negative format.

*/ inline void SetNegativeFormat(const NegativeFormat& value) { m_negativeFormatHasBeenSet = true; m_negativeFormat = value; } /** *

The negative format.

*/ inline void SetNegativeFormat(NegativeFormat&& value) { m_negativeFormatHasBeenSet = true; m_negativeFormat = std::move(value); } /** *

The negative format.

*/ inline DisplayFormatOptions& WithNegativeFormat(const NegativeFormat& value) { SetNegativeFormat(value); return *this;} /** *

The negative format.

*/ inline DisplayFormatOptions& WithNegativeFormat(NegativeFormat&& value) { SetNegativeFormat(std::move(value)); return *this;} /** *

The currency symbol, such as USD.

*/ inline const Aws::String& GetCurrencySymbol() const{ return m_currencySymbol; } /** *

The currency symbol, such as USD.

*/ inline bool CurrencySymbolHasBeenSet() const { return m_currencySymbolHasBeenSet; } /** *

The currency symbol, such as USD.

*/ inline void SetCurrencySymbol(const Aws::String& value) { m_currencySymbolHasBeenSet = true; m_currencySymbol = value; } /** *

The currency symbol, such as USD.

*/ inline void SetCurrencySymbol(Aws::String&& value) { m_currencySymbolHasBeenSet = true; m_currencySymbol = std::move(value); } /** *

The currency symbol, such as USD.

*/ inline void SetCurrencySymbol(const char* value) { m_currencySymbolHasBeenSet = true; m_currencySymbol.assign(value); } /** *

The currency symbol, such as USD.

*/ inline DisplayFormatOptions& WithCurrencySymbol(const Aws::String& value) { SetCurrencySymbol(value); return *this;} /** *

The currency symbol, such as USD.

*/ inline DisplayFormatOptions& WithCurrencySymbol(Aws::String&& value) { SetCurrencySymbol(std::move(value)); return *this;} /** *

The currency symbol, such as USD.

*/ inline DisplayFormatOptions& WithCurrencySymbol(const char* value) { SetCurrencySymbol(value); return *this;} private: bool m_useBlankCellFormat; bool m_useBlankCellFormatHasBeenSet = false; Aws::String m_blankCellFormat; bool m_blankCellFormatHasBeenSet = false; Aws::String m_dateFormat; bool m_dateFormatHasBeenSet = false; TopicNumericSeparatorSymbol m_decimalSeparator; bool m_decimalSeparatorHasBeenSet = false; Aws::String m_groupingSeparator; bool m_groupingSeparatorHasBeenSet = false; bool m_useGrouping; bool m_useGroupingHasBeenSet = false; int m_fractionDigits; bool m_fractionDigitsHasBeenSet = false; Aws::String m_prefix; bool m_prefixHasBeenSet = false; Aws::String m_suffix; bool m_suffixHasBeenSet = false; NumberScale m_unitScaler; bool m_unitScalerHasBeenSet = false; NegativeFormat m_negativeFormat; bool m_negativeFormatHasBeenSet = false; Aws::String m_currencySymbol; bool m_currencySymbolHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws