All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnTemplate.RelativeDatesFilterProperty.Jsii$Proxy

Enclosing class:: CfnTemplate

@Stability(Stable) public static interface CfnTemplate.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
         .defaultFilterControlConfiguration(DefaultFilterControlConfigurationProperty.builder()
                 .controlOptions(DefaultFilterControlOptionsProperty.builder()
                         .defaultDateTimePickerOptions(DefaultDateTimePickerControlOptionsProperty.builder()
                                 .displayOptions(DateTimePickerControlDisplayOptionsProperty.builder()
                                         .dateTimeFormat("dateTimeFormat")
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultDropdownOptions(DefaultFilterDropDownControlOptionsProperty.builder()
                                 .displayOptions(DropDownControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .selectableValues(FilterSelectableValuesProperty.builder()
                                         .values(List.of("values"))
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultListOptions(DefaultFilterListControlOptionsProperty.builder()
                                 .displayOptions(ListControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .searchOptions(ListControlSearchOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .selectableValues(FilterSelectableValuesProperty.builder()
                                         .values(List.of("values"))
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultRelativeDateTimeOptions(DefaultRelativeDateTimeControlOptionsProperty.builder()
                                 .displayOptions(RelativeDateTimeControlDisplayOptionsProperty.builder()
                                         .dateTimeFormat("dateTimeFormat")
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .defaultSliderOptions(DefaultSliderControlOptionsProperty.builder()
                                 .maximumValue(123)
                                 .minimumValue(123)
                                 .stepSize(123)
                                 // the properties below are optional
                                 .displayOptions(SliderControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .type("type")
                                 .build())
                         .defaultTextAreaOptions(DefaultTextAreaControlOptionsProperty.builder()
                                 .delimiter("delimiter")
                                 .displayOptions(TextAreaControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .defaultTextFieldOptions(DefaultTextFieldControlOptionsProperty.builder()
                                 .displayOptions(TextFieldControlDisplayOptionsProperty.builder()
                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                 .infoIconText("infoIconText")
                                                 .visibility("visibility")
                                                 .build())
                                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                                 .visibility("visibility")
                                                 .build())
                                         .titleOptions(LabelOptionsProperty.builder()
                                                 .customLabel("customLabel")
                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                         .fontColor("fontColor")
                                                         .fontDecoration("fontDecoration")
                                                         .fontSize(FontSizeProperty.builder()
                                                                 .relative("relative")
                                                                 .build())
                                                         .fontStyle("fontStyle")
                                                         .fontWeight(FontWeightProperty.builder()
                                                                 .name("name")
                                                                 .build())
                                                         .build())
                                                 .visibility("visibility")
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .title("title")
                 .build())
         .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                 .amount(123)
                 .granularity("granularity")
                 // the properties below are optional
                 .status("status")
                 .build())
         .minimumGranularity("minimumGranularity")
         .parameterName("parameterName")
         .relativeDateValue(123)
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnTemplate.RelativeDatesFilterProperty.Builder

A builder for CfnTemplate.RelativeDatesFilterProperty

static final class

CfnTemplate.RelativeDatesFilterProperty.Jsii$Proxy

An implementation for CfnTemplate.RelativeDatesFilterProperty
Method Summary

Modifier and Type

Method

Description

static CfnTemplate.RelativeDatesFilterProperty.Builder

builder()

Object

getAnchorDateConfiguration()

The date configuration of the filter.

Object

getColumn()

The column that the filter is applied to.

default Object

getDefaultFilterControlConfiguration()

The default configurations for the associated controls.

default Object

getExcludePeriodConfiguration()

The configuration for the exclude period of the filter.

String

getFilterId()

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

default String

getMinimumGranularity()

The minimum granularity (period granularity) of the relative dates filter.

String

getNullOption()

This option determines how null values should be treated when filtering data.

default String

getParameterName()

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

String

getRelativeDateType()

The range date type of the filter.

default Number

getRelativeDateValue()

The date value of the filter.

String

getTimeGranularity()

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAnchorDateConfiguration
  
  @Stability(Stable) @NotNull Object getAnchorDateConfiguration()
  
  The date configuration of the filter.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-anchordateconfiguration
- 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-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-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-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-filterid
- 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-nulloption
- getRelativeDateType
  
  @Stability(Stable) @NotNull String getRelativeDateType()
  The range date type of the filter. Choose one of the options below:.
  
  PREVIOUS
  
  THIS
  
  LAST
  
  NOW
  
  NEXT
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-relativedatetype
- getTimeGranularity
  
  @Stability(Stable) @NotNull 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-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-timegranularity
- getDefaultFilterControlConfiguration
  
  @Stability(Stable) @Nullable default Object getDefaultFilterControlConfiguration()
  
  The default configurations for the associated controls.
  This applies only for filters that are scoped to multiple sheets.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-defaultfiltercontrolconfiguration
- getExcludePeriodConfiguration
  
  @Stability(Stable) @Nullable default Object getExcludePeriodConfiguration()
  
  The configuration for the exclude period of the filter.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-excludeperiodconfiguration
- getMinimumGranularity
  
  @Stability(Stable) @Nullable default String getMinimumGranularity()
  
  The minimum granularity (period granularity) of the relative dates filter.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-minimumgranularity
- getParameterName
  
  @Stability(Stable) @Nullable default String getParameterName()
  
  The parameter whose value should be used for the filter value.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-parametername
- getRelativeDateValue
  
  @Stability(Stable) @Nullable default Number getRelativeDateValue()
  
  The date value of the filter.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-relativedatesfilter.html#cfn-quicksight-template-relativedatesfilter-relativedatevalue
- builder
  
  @Stability(Stable) static CfnTemplate.RelativeDatesFilterProperty.Builder builder()
  
  Returns:
  
  a CfnTemplate.RelativeDatesFilterProperty.Builder of CfnTemplate.RelativeDatesFilterProperty

Interface CfnTemplate.RelativeDatesFilterProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAnchorDateConfiguration

getColumn

getFilterId

getNullOption

getRelativeDateType

getTimeGranularity

getDefaultFilterControlConfiguration

getExcludePeriodConfiguration

getMinimumGranularity

getParameterName

getRelativeDateValue

builder