Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.ColumnSortProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.ColumnSortProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.ColumnSortProperty
extends software.amazon.jsii.JsiiSerializable

The sort configuration for a column that is not used in a field well.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 ColumnSortProperty columnSortProperty = ColumnSortProperty.builder()
         .direction("direction")
         .sortBy(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         // the properties below are optional
         .aggregationFunction(AggregationFunctionProperty.builder()
                 .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                         .simpleAttributeAggregation("simpleAttributeAggregation")
                         .valueForMultipleValues("valueForMultipleValues")
                         .build())
                 .categoricalAggregationFunction("categoricalAggregationFunction")
                 .dateAggregationFunction("dateAggregationFunction")
                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                         .percentileAggregation(PercentileAggregationProperty.builder()
                                 .percentileValue(123)
                                 .build())
                         .simpleNumericalAggregation("simpleNumericalAggregation")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.ColumnSortProperty.Builder	A builder for CfnDashboard.ColumnSortProperty
static final class	CfnDashboard.ColumnSortProperty.Jsii$Proxy	An implementation for CfnDashboard.ColumnSortProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.ColumnSortProperty.Builder	builder()
default Object	getAggregationFunction()	The aggregation function that is defined in the column sort.
String	getDirection()	The sort direction.
Object	getSortBy()	Returns union: either IResolvable or CfnDashboard.ColumnIdentifierProperty

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDirection

@Stability(Stable)
@NotNull
String getDirection()

The sort direction.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-direction

getSortBy

@Stability(Stable)
@NotNull
Object getSortBy()

Returns union: either IResolvable or CfnDashboard.ColumnIdentifierProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-sortby

getAggregationFunction

@Stability(Stable)
@Nullable
default Object getAggregationFunction()

The aggregation function that is defined in the column sort.

Returns union: either IResolvable or CfnDashboard.AggregationFunctionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-columnsort.html#cfn-quicksight-dashboard-columnsort-aggregationfunction

builder

@Stability(Stable)
static CfnDashboard.ColumnSortProperty.Builder builder()

Returns:

a CfnDashboard.ColumnSortProperty.Builder of CfnDashboard.ColumnSortProperty