Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.TimeEqualityFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.TimeEqualityFilterProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

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

A TimeEqualityFilter filters values that are equal to a given value.

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.*;
 TimeEqualityFilterProperty timeEqualityFilterProperty = TimeEqualityFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         // the properties below are optional
         .parameterName("parameterName")
         .rollingDate(RollingDateConfigurationProperty.builder()
                 .expression("expression")
                 // the properties below are optional
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .timeGranularity("timeGranularity")
         .value("value")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.TimeEqualityFilterProperty.Builder	builder()
Object	getColumn()	The column that the filter is applied to.
String	getFilterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
default String	getParameterName()	The parameter whose value should be used for the filter value.
default Object	getRollingDate()	The rolling date input for the TimeEquality filter.
default String	getTimeGranularity()	The level of time precision that is used to aggregate DateTime values.
default String	getValue()	The value of a TimeEquality filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that the filter is applied to.

See Also:

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

getFilterId

@Stability(Stable)
@NotNull
String getFilterId()

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

See Also:

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

getParameterName

@Stability(Stable)
@Nullable
default String getParameterName()

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

This field is mutually exclusive to Value and RollingDate .

See Also:

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

getRollingDate

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

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName .

See Also:

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

getTimeGranularity

@Stability(Stable)
@Nullable
default String getTimeGranularity()

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

See Also:

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

getValue

@Stability(Stable)
@Nullable
default String getValue()

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName .

See Also:

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

builder

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

Returns:

a CfnDashboard.TimeEqualityFilterProperty.Builder of CfnDashboard.TimeEqualityFilterProperty