Package software.amazon.awscdk.services.quicksight

Class CfnDashboard.TimeRangeFilterProperty.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnDashboard.TimeRangeFilterProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDashboard.TimeRangeFilterProperty>

Enclosing interface:

CfnDashboard.TimeRangeFilterProperty

@Stability(Stable)
public static final class CfnDashboard.TimeRangeFilterProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboard.TimeRangeFilterProperty>

A builder for CfnDashboard.TimeRangeFilterProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDashboard.TimeRangeFilterProperty	build()	Builds the configured instance.
CfnDashboard.TimeRangeFilterProperty.Builder	column(IResolvable column)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getColumn()
CfnDashboard.TimeRangeFilterProperty.Builder	column(CfnDashboard.ColumnIdentifierProperty column)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getColumn()
CfnDashboard.TimeRangeFilterProperty.Builder	defaultFilterControlConfiguration(IResolvable defaultFilterControlConfiguration)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getDefaultFilterControlConfiguration()
CfnDashboard.TimeRangeFilterProperty.Builder	defaultFilterControlConfiguration(CfnDashboard.DefaultFilterControlConfigurationProperty defaultFilterControlConfiguration)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getDefaultFilterControlConfiguration()
CfnDashboard.TimeRangeFilterProperty.Builder	excludePeriodConfiguration(IResolvable excludePeriodConfiguration)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()
CfnDashboard.TimeRangeFilterProperty.Builder	excludePeriodConfiguration(CfnDashboard.ExcludePeriodConfigurationProperty excludePeriodConfiguration)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()
CfnDashboard.TimeRangeFilterProperty.Builder	filterId(String filterId)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getFilterId()
CfnDashboard.TimeRangeFilterProperty.Builder	includeMaximum(Boolean includeMaximum)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()
CfnDashboard.TimeRangeFilterProperty.Builder	includeMaximum(IResolvable includeMaximum)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()
CfnDashboard.TimeRangeFilterProperty.Builder	includeMinimum(Boolean includeMinimum)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()
CfnDashboard.TimeRangeFilterProperty.Builder	includeMinimum(IResolvable includeMinimum)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()
CfnDashboard.TimeRangeFilterProperty.Builder	nullOption(String nullOption)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getNullOption()
CfnDashboard.TimeRangeFilterProperty.Builder	rangeMaximumValue(IResolvable rangeMaximumValue)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()
CfnDashboard.TimeRangeFilterProperty.Builder	rangeMaximumValue(CfnDashboard.TimeRangeFilterValueProperty rangeMaximumValue)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()
CfnDashboard.TimeRangeFilterProperty.Builder	rangeMinimumValue(IResolvable rangeMinimumValue)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()
CfnDashboard.TimeRangeFilterProperty.Builder	rangeMinimumValue(CfnDashboard.TimeRangeFilterValueProperty rangeMinimumValue)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()
CfnDashboard.TimeRangeFilterProperty.Builder	timeGranularity(String timeGranularity)	Sets the value of CfnDashboard.TimeRangeFilterProperty.getTimeGranularity()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

column

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder column(IResolvable column)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getColumn()

Parameters:

column - The column that the filter is applied to. This parameter is required.

Returns:

this

column

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder column(CfnDashboard.ColumnIdentifierProperty column)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getColumn()

Parameters:

column - The column that the filter is applied to. This parameter is required.

Returns:

this

filterId

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder filterId(String filterId)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getFilterId()

Parameters:

filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template. This parameter is required.

Returns:

this

nullOption

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder nullOption(String nullOption)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getNullOption()

Parameters:

nullOption - This option determines how null values should be treated when filtering data. This parameter is required.

• 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.

Returns:

this

defaultFilterControlConfiguration

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder defaultFilterControlConfiguration(IResolvable defaultFilterControlConfiguration)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getDefaultFilterControlConfiguration()

Parameters:

defaultFilterControlConfiguration - The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

this

defaultFilterControlConfiguration

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder defaultFilterControlConfiguration(CfnDashboard.DefaultFilterControlConfigurationProperty defaultFilterControlConfiguration)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getDefaultFilterControlConfiguration()

Parameters:

defaultFilterControlConfiguration - The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

this

excludePeriodConfiguration

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder excludePeriodConfiguration(IResolvable excludePeriodConfiguration)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()

Parameters:

excludePeriodConfiguration - The exclude period of the time range filter.

Returns:

this

excludePeriodConfiguration

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder excludePeriodConfiguration(CfnDashboard.ExcludePeriodConfigurationProperty excludePeriodConfiguration)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()

Parameters:

excludePeriodConfiguration - The exclude period of the time range filter.

Returns:

this

includeMaximum

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder includeMaximum(Boolean includeMaximum)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()

Parameters:

includeMaximum - Determines whether the maximum value in the filter value range should be included in the filtered results.

Returns:

this

includeMaximum

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder includeMaximum(IResolvable includeMaximum)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()

Parameters:

includeMaximum - Determines whether the maximum value in the filter value range should be included in the filtered results.

Returns:

this

includeMinimum

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder includeMinimum(Boolean includeMinimum)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()

Parameters:

includeMinimum - Determines whether the minimum value in the filter value range should be included in the filtered results.

Returns:

this

includeMinimum

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder includeMinimum(IResolvable includeMinimum)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()

Parameters:

includeMinimum - Determines whether the minimum value in the filter value range should be included in the filtered results.

Returns:

this

rangeMaximumValue

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder rangeMaximumValue(IResolvable rangeMaximumValue)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()

Parameters:

rangeMaximumValue - The maximum value for the filter value range.

Returns:

this

rangeMaximumValue

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder rangeMaximumValue(CfnDashboard.TimeRangeFilterValueProperty rangeMaximumValue)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()

Parameters:

rangeMaximumValue - The maximum value for the filter value range.

Returns:

this

rangeMinimumValue

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder rangeMinimumValue(IResolvable rangeMinimumValue)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()

Parameters:

rangeMinimumValue - The minimum value for the filter value range.

Returns:

this

rangeMinimumValue

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder rangeMinimumValue(CfnDashboard.TimeRangeFilterValueProperty rangeMinimumValue)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()

Parameters:

rangeMinimumValue - The minimum value for the filter value range.

Returns:

this

timeGranularity

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty.Builder timeGranularity(String timeGranularity)

Sets the value of CfnDashboard.TimeRangeFilterProperty.getTimeGranularity()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnDashboard.TimeRangeFilterProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDashboard.TimeRangeFilterProperty>

Returns:

a new instance of CfnDashboard.TimeRangeFilterProperty

Throws:

NullPointerException - if any required attribute was not provided