Interface CfnDashboard.RelativeDatesFilterProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDashboard.RelativeDatesFilterProperty.Jsii$Proxy
Enclosing class:
CfnDashboard

@Stability(Stable) public static interface CfnDashboard.RelativeDatesFilterProperty extends software.amazon.jsii.JsiiSerializable
A RelativeDatesFilter filters relative dates values.

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.*;
 RelativeDatesFilterProperty relativeDatesFilterProperty = RelativeDatesFilterProperty.builder()
         .anchorDateConfiguration(AnchorDateConfigurationProperty.builder()
                 .anchorOption("anchorOption")
                 .parameterName("parameterName")
                 .build())
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         .nullOption("nullOption")
         .relativeDateType("relativeDateType")
         .timeGranularity("timeGranularity")
         // the properties below are optional
         .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                 .amount(123)
                 .granularity("granularity")
                 // the properties below are optional
                 .status("status")
                 .build())
         .minimumGranularity("minimumGranularity")
         .parameterName("parameterName")
         .relativeDateValue(123)
         .build();
 
  • Method Details

    • getAnchorDateConfiguration

      @Stability(Stable) @NotNull Object getAnchorDateConfiguration()
      The date configuration of the filter.
    • getColumn

      @Stability(Stable) @NotNull Object getColumn()
      The column that the filter is applied to.
    • getFilterId

      @Stability(Stable) @NotNull String getFilterId()
      An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    • getNullOption

      @Stability(Stable) @NotNull String getNullOption()
      This option determines how null values should be treated when filtering data.

      • ALL_VALUES : Include null values in filtered results.
      • NULLS_ONLY : Only include null values in filtered results.
      • NON_NULLS_ONLY : Exclude null values from filtered results.
    • getRelativeDateType

      @Stability(Stable) @NotNull String getRelativeDateType()
      The range date type of the filter. Choose one of the options below:.

      • PREVIOUS
      • THIS
      • LAST
      • NOW
      • NEXT
    • getTimeGranularity

      @Stability(Stable) @NotNull String getTimeGranularity()
      The level of time precision that is used to aggregate DateTime values.
    • getExcludePeriodConfiguration

      @Stability(Stable) @Nullable default Object getExcludePeriodConfiguration()
      The configuration for the exclude period of the filter.
    • getMinimumGranularity

      @Stability(Stable) @Nullable default String getMinimumGranularity()
      The minimum granularity (period granularity) of the relative dates filter.
    • getParameterName

      @Stability(Stable) @Nullable default String getParameterName()
      The parameter whose value should be used for the filter value.
    • getRelativeDateValue

      @Stability(Stable) @Nullable default Number getRelativeDateValue()
      The date value of the filter.
    • builder

      @Stability(Stable) static CfnDashboard.RelativeDatesFilterProperty.Builder builder()
      Returns:
      a CfnDashboard.RelativeDatesFilterProperty.Builder of CfnDashboard.RelativeDatesFilterProperty