Interface CfnTemplate.RelativeDatesFilterProperty
- 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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.RelativeDatesFilterProperty
static final class
An implementation forCfnTemplate.RelativeDatesFilterProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The date configuration of the filter.The column that the filter is applied to.default Object
The default configurations for the associated controls.default Object
The configuration for the exclude period of the filter.An identifier that uniquely identifies a filter within a dashboard, analysis, or template.default String
The minimum granularity (period granularity) of the relative dates filter.This option determines how null values should be treated when filtering data.default String
The parameter whose value should be used for the filter value.The range date type of the filter.default Number
The date value of the filter.The level of time precision that is used to aggregateDateTime
values.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAnchorDateConfiguration
The date configuration of the filter.- See Also:
-
getColumn
The column that the filter is applied to.- See Also:
-
getFilterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.- See Also:
-
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:
-
getRelativeDateType
The range date type of the filter. Choose one of the options below:.PREVIOUS
THIS
LAST
NOW
NEXT
- See Also:
-
getTimeGranularity
The level of time precision that is used to aggregateDateTime
values.- See Also:
-
getDefaultFilterControlConfiguration
The default configurations for the associated controls.This applies only for filters that are scoped to multiple sheets.
- See Also:
-
getExcludePeriodConfiguration
The configuration for the exclude period of the filter.- See Also:
-
getMinimumGranularity
The minimum granularity (period granularity) of the relative dates filter.- See Also:
-
getParameterName
The parameter whose value should be used for the filter value.- See Also:
-
getRelativeDateValue
The date value of the filter.- See Also:
-
builder
-