Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.PivotTableSortByProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.PivotTableSortByProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

The sort by field for the field sort options.

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.*;
 PivotTableSortByProperty pivotTableSortByProperty = PivotTableSortByProperty.builder()
         .column(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())
         .dataPath(DataPathSortProperty.builder()
                 .direction("direction")
                 .sortPaths(List.of(DataPathValueProperty.builder()
                         .dataPathType(DataPathTypeProperty.builder()
                                 .pivotTableDataPathType("pivotTableDataPathType")
                                 .build())
                         .fieldId("fieldId")
                         .fieldValue("fieldValue")
                         .build()))
                 .build())
         .field(FieldSortProperty.builder()
                 .direction("direction")
                 .fieldId("fieldId")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.PivotTableSortByProperty.Builder	builder()
default Object	getColumn()	The column sort (field id, direction) for the pivot table sort by options.
default Object	getDataPath()	The data path sort (data path value, direction) for the pivot table sort by options.
default Object	getField()	The field sort (field id, direction) for the pivot table sort by options.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumn

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

The column sort (field id, direction) for the pivot table sort by options.

Returns union: either IResolvable or CfnDashboard.ColumnSortProperty

See Also:

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

getDataPath

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

The data path sort (data path value, direction) for the pivot table sort by options.

Returns union: either IResolvable or CfnDashboard.DataPathSortProperty

See Also:

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

getField

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

The field sort (field id, direction) for the pivot table sort by options.

Returns union: either IResolvable or CfnDashboard.FieldSortProperty

See Also:

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

builder

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

Returns:

a CfnDashboard.PivotTableSortByProperty.Builder of CfnDashboard.PivotTableSortByProperty