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

Class TopBottomFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TopBottomFilter

All Implemented Interfaces:

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

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

A TopBottomFilter filters values that are at the top or the bottom.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TopBottomFilter.Builder

Method Summary

Modifier and Type	Method	Description
List<AggregationSortConfiguration>	aggregationSortConfigurations()	The aggregation and sort configuration of the top bottom filter.
static TopBottomFilter.Builder	builder()
ColumnIdentifier	column()	The column that the filter is applied to.
DefaultFilterControlConfiguration	defaultFilterControlConfiguration()	The default configurations for the associated controls.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregationSortConfigurations()	For responses, this returns true if the service returned a value for the AggregationSortConfigurations property.
int	hashCode()
Integer	limit()	The number of items to include in the top bottom filter results.
String	parameterName()	The parameter whose value should be used for the filter value.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TopBottomFilter.Builder>	serializableBuilderClass()
TimeGranularity	timeGranularity()	The level of time precision that is used to aggregate DateTime values.
String	timeGranularityAsString()	The level of time precision that is used to aggregate DateTime values.
TopBottomFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

filterId

public final String filterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

column

public final ColumnIdentifier column()

The column that the filter is applied to.

Returns:

The column that the filter is applied to.

limit

public final Integer limit()

The number of items to include in the top bottom filter results.

Returns:

The number of items to include in the top bottom filter results.

hasAggregationSortConfigurations

public final boolean hasAggregationSortConfigurations()

For responses, this returns true if the service returned a value for the AggregationSortConfigurations 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.

aggregationSortConfigurations

public final List<AggregationSortConfiguration> aggregationSortConfigurations()

The aggregation and sort configuration of the top bottom filter.

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 hasAggregationSortConfigurations() method.

Returns:

The aggregation and sort configuration of the top bottom filter.

timeGranularity

public final TimeGranularity timeGranularity()

The level of time precision that is used to aggregate DateTime values.

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

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

timeGranularityAsString

public final String timeGranularityAsString()

The level of time precision that is used to aggregate DateTime values.

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

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

parameterName

public final String parameterName()

The parameter whose value should be used for the filter value.

Returns:

The parameter whose value should be used for the filter value.

defaultFilterControlConfiguration

public final DefaultFilterControlConfiguration defaultFilterControlConfiguration()

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

toBuilder

public TopBottomFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TopBottomFilter.Builder,TopBottomFilter>

builder

public static TopBottomFilter.Builder builder()

serializableBuilderClass

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