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

Class TotalOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TotalOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TotalOptions.Builder,TotalOptions>

@Generated("software.amazon.awssdk:codegen")
public final class TotalOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TotalOptions.Builder,TotalOptions>

The total options for a table visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TotalOptions.Builder

Method Summary

Modifier and Type	Method	Description
static TotalOptions.Builder	builder()
String	customLabel()	The custom label string for the total cells.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTotalAggregationOptions()	For responses, this returns true if the service returned a value for the TotalAggregationOptions property.
TableTotalsPlacement	placement()	The placement (start, end) for the total cells.
String	placementAsString()	The placement (start, end) for the total cells.
TableTotalsScrollStatus	scrollStatus()	The scroll status (pinned, scrolled) for the total cells.
String	scrollStatusAsString()	The scroll status (pinned, scrolled) for the total cells.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TotalOptions.Builder>	serializableBuilderClass()
TotalOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<TotalAggregationOption>	totalAggregationOptions()	The total aggregation settings for each value field.
TableCellStyle	totalCellStyle()	Cell styling options for the total cells.
Visibility	totalsVisibility()	The visibility configuration for the total cells.
String	totalsVisibilityAsString()	The visibility configuration for the total cells.

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

totalsVisibility

public final Visibility totalsVisibility()

The visibility configuration for the total cells.

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

Returns:

The visibility configuration for the total cells.

See Also:

Visibility

totalsVisibilityAsString

public final String totalsVisibilityAsString()

The visibility configuration for the total cells.

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

Returns:

The visibility configuration for the total cells.

See Also:

Visibility

placement

public final TableTotalsPlacement placement()

The placement (start, end) for the total cells.

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

Returns:

The placement (start, end) for the total cells.

See Also:

TableTotalsPlacement

placementAsString

public final String placementAsString()

The placement (start, end) for the total cells.

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

Returns:

The placement (start, end) for the total cells.

See Also:

TableTotalsPlacement

scrollStatus

public final TableTotalsScrollStatus scrollStatus()

The scroll status (pinned, scrolled) for the total cells.

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

Returns:

The scroll status (pinned, scrolled) for the total cells.

See Also:

TableTotalsScrollStatus

scrollStatusAsString

public final String scrollStatusAsString()

The scroll status (pinned, scrolled) for the total cells.

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

Returns:

The scroll status (pinned, scrolled) for the total cells.

See Also:

TableTotalsScrollStatus

customLabel

public final String customLabel()

The custom label string for the total cells.

Returns:

The custom label string for the total cells.

totalCellStyle

public final TableCellStyle totalCellStyle()

Cell styling options for the total cells.

Returns:

Cell styling options for the total cells.

hasTotalAggregationOptions

public final boolean hasTotalAggregationOptions()

For responses, this returns true if the service returned a value for the TotalAggregationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

totalAggregationOptions

public final List<TotalAggregationOption> totalAggregationOptions()

The total aggregation settings for each value field.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTotalAggregationOptions() method.

Returns:

The total aggregation settings for each value field.

toBuilder

public TotalOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TotalOptions.Builder,TotalOptions>

builder

public static TotalOptions.Builder builder()

serializableBuilderClass

public static Class<? extends TotalOptions.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo