Package software.amazon.awssdk.services.quicksight.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DisplayFormatOptions.Builder

Method Summary

Modifier and Type	Method	Description
String	blankCellFormat()	Determines the blank cell format.
static DisplayFormatOptions.Builder	builder()
String	currencySymbol()	The currency symbol, such as USD.
String	dateFormat()	Determines the DateTime format.
TopicNumericSeparatorSymbol	decimalSeparator()	Determines the decimal separator.
String	decimalSeparatorAsString()	Determines the decimal separator.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fractionDigits()	Determines the number of fraction digits.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupingSeparator()	Determines the grouping separator.
int	hashCode()
NegativeFormat	negativeFormat()	The negative format.
String	prefix()	The prefix value for a display format.
List<SdkField<?>>	sdkFields()
static Class<? extends DisplayFormatOptions.Builder>	serializableBuilderClass()
String	suffix()	The suffix value for a display format.
DisplayFormatOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
NumberScale	unitScaler()	The unit scaler.
String	unitScalerAsString()	The unit scaler.
Boolean	useBlankCellFormat()	A Boolean value that indicates whether to use blank cell format.
Boolean	useGrouping()	A Boolean value that indicates whether to use grouping.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

TopicNumericSeparatorSymbol

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:

TopicNumericSeparatorSymbol

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:

NumberScale

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:

NumberScale

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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