Class DisplayFormatOptions

java.lang.Object
software.amazon.awssdk.services.quicksight.model.DisplayFormatOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>
@Generated("software.amazon.awssdk:codegen") public final class DisplayFormatOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>

A structure that represents additional options for display formatting.

See Also:

  • Method Details

    • useBlankCellFormat

      public final Boolean useBlankCellFormat()

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

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

    • blankCellFormat

      public final String blankCellFormat()

      Determines the blank cell format.

      Returns:
      Determines the blank cell format.

    • dateFormat

      public final String dateFormat()

      Determines the DateTime format.

      Returns:
      Determines the DateTime format.

    • decimalSeparator

      public final TopicNumericSeparatorSymbol decimalSeparator()

      Determines the decimal separator.

      If the service returns an enum value that is not available in the current SDK version, decimalSeparator will return TopicNumericSeparatorSymbol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from decimalSeparatorAsString().

      Returns:
      Determines the decimal separator.
      See Also:

    • decimalSeparatorAsString

      public final String decimalSeparatorAsString()

      Determines the decimal separator.

      If the service returns an enum value that is not available in the current SDK version, decimalSeparator will return TopicNumericSeparatorSymbol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from decimalSeparatorAsString().

      Returns:
      Determines the decimal separator.
      See Also:

    • groupingSeparator

      public final String groupingSeparator()

      Determines the grouping separator.

      Returns:
      Determines the grouping separator.

    • useGrouping

      public final Boolean useGrouping()

      A Boolean value that indicates whether to use grouping.

      Returns:
      A Boolean value that indicates whether to use grouping.

    • fractionDigits

      public final Integer fractionDigits()

      Determines the number of fraction digits.

      Returns:
      Determines the number of fraction digits.

    • prefix

      public final String prefix()

      The prefix value for a display format.

      Returns:
      The prefix value for a display format.

    • suffix

      public final String suffix()

      The suffix value for a display format.

      Returns:
      The suffix value for a display format.

    • unitScaler

      public final NumberScale unitScaler()

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

      If the service returns an enum value that is not available in the current SDK version, unitScaler will return NumberScale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitScalerAsString().

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

    • unitScalerAsString

      public final String unitScalerAsString()

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

      If the service returns an enum value that is not available in the current SDK version, unitScaler will return NumberScale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitScalerAsString().

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

    • negativeFormat

      public final NegativeFormat negativeFormat()

      The negative format.

      Returns:
      The negative format.

    • currencySymbol

      public final String currencySymbol()

      The currency symbol, such as USD.

      Returns:
      The currency symbol, such as USD.

    • toBuilder

      public DisplayFormatOptions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>
      Returns:
      a builder for type T

    • builder

      public static DisplayFormatOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DisplayFormatOptions.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.