TimeRangeFilter (AWS Java SDK for Amazon QuickSight 1.12.770 API)

java.lang.Object
- com.amazonaws.services.quicksight.model.TimeRangeFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TimeRangeFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A TimeRangeFilter filters values that are between two specified values.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TimeRangeFilter()

Constructors
Constructor and Description
`TimeRangeFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeRangeFilter`	`clone()`
`boolean`	`equals(Object obj)`
`ColumnIdentifier`	`getColumn()` The column that the filter is applied to.
`DefaultFilterControlConfiguration`	`getDefaultFilterControlConfiguration()` The default configurations for the associated controls.
`ExcludePeriodConfiguration`	`getExcludePeriodConfiguration()` The exclude period of the time range filter.
`String`	`getFilterId()` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`Boolean`	`getIncludeMaximum()` Determines whether the maximum value in the filter value range should be included in the filtered results.
`Boolean`	`getIncludeMinimum()` Determines whether the minimum value in the filter value range should be included in the filtered results.
`String`	`getNullOption()` This option determines how null values should be treated when filtering data.
`TimeRangeFilterValue`	`getRangeMaximumValue()` The maximum value for the filter value range.
`TimeRangeFilterValue`	`getRangeMinimumValue()` The minimum value for the filter value range.
`String`	`getTimeGranularity()` The level of time precision that is used to aggregate `DateTime` values.
`int`	`hashCode()`
`Boolean`	`isIncludeMaximum()` Determines whether the maximum value in the filter value range should be included in the filtered results.
`Boolean`	`isIncludeMinimum()` Determines whether the minimum value in the filter value range should be included in the filtered results.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setColumn(ColumnIdentifier column)` The column that the filter is applied to.
`void`	`setDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)` The default configurations for the associated controls.
`void`	`setExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)` The exclude period of the time range filter.
`void`	`setFilterId(String filterId)` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`void`	`setIncludeMaximum(Boolean includeMaximum)` Determines whether the maximum value in the filter value range should be included in the filtered results.
`void`	`setIncludeMinimum(Boolean includeMinimum)` Determines whether the minimum value in the filter value range should be included in the filtered results.
`void`	`setNullOption(String nullOption)` This option determines how null values should be treated when filtering data.
`void`	`setRangeMaximumValue(TimeRangeFilterValue rangeMaximumValue)` The maximum value for the filter value range.
`void`	`setRangeMinimumValue(TimeRangeFilterValue rangeMinimumValue)` The minimum value for the filter value range.
`void`	`setTimeGranularity(String timeGranularity)` The level of time precision that is used to aggregate `DateTime` values.
`String`	`toString()` Returns a string representation of this object.
`TimeRangeFilter`	`withColumn(ColumnIdentifier column)` The column that the filter is applied to.
`TimeRangeFilter`	`withDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)` The default configurations for the associated controls.
`TimeRangeFilter`	`withExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)` The exclude period of the time range filter.
`TimeRangeFilter`	`withFilterId(String filterId)` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`TimeRangeFilter`	`withIncludeMaximum(Boolean includeMaximum)` Determines whether the maximum value in the filter value range should be included in the filtered results.
`TimeRangeFilter`	`withIncludeMinimum(Boolean includeMinimum)` Determines whether the minimum value in the filter value range should be included in the filtered results.
`TimeRangeFilter`	`withNullOption(FilterNullOption nullOption)` This option determines how null values should be treated when filtering data.
`TimeRangeFilter`	`withNullOption(String nullOption)` This option determines how null values should be treated when filtering data.
`TimeRangeFilter`	`withRangeMaximumValue(TimeRangeFilterValue rangeMaximumValue)` The maximum value for the filter value range.
`TimeRangeFilter`	`withRangeMinimumValue(TimeRangeFilterValue rangeMinimumValue)` The minimum value for the filter value range.
`TimeRangeFilter`	`withTimeGranularity(String timeGranularity)` The level of time precision that is used to aggregate `DateTime` values.
`TimeRangeFilter`	`withTimeGranularity(TimeGranularity timeGranularity)` The level of time precision that is used to aggregate `DateTime` values.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TimeRangeFilter
```
public TimeRangeFilter()
```
- Method Detail
  - setFilterId
```
public void setFilterId(String filterId)
```
    An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Parameters:
    
    filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  - getFilterId
```
public String getFilterId()
```
    An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Returns:
    
    An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  - withFilterId
```
public TimeRangeFilter withFilterId(String filterId)
```
    An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Parameters:
    
    filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumn
```
public void setColumn(ColumnIdentifier column)
```
    The column that the filter is applied to.
    
    Parameters:
    
    column - The column that the filter is applied to.
  - getColumn
```
public ColumnIdentifier getColumn()
```
    The column that the filter is applied to.
    
    Returns:
    
    The column that the filter is applied to.
  - withColumn
```
public TimeRangeFilter withColumn(ColumnIdentifier column)
```
    The column that the filter is applied to.
    
    Parameters:
    
    column - The column that the filter is applied to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeMinimum
```
public void setIncludeMinimum(Boolean includeMinimum)
```
    Determines whether the minimum value in the filter value range should be included in the filtered results.
    
    Parameters:
    
    includeMinimum - Determines whether the minimum value in the filter value range should be included in the filtered results.
  - getIncludeMinimum
```
public Boolean getIncludeMinimum()
```
    Determines whether the minimum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Determines whether the minimum value in the filter value range should be included in the filtered results.
  - withIncludeMinimum
```
public TimeRangeFilter withIncludeMinimum(Boolean includeMinimum)
```
    Determines whether the minimum value in the filter value range should be included in the filtered results.
    
    Parameters:
    
    includeMinimum - Determines whether the minimum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeMinimum
```
public Boolean isIncludeMinimum()
```
    Determines whether the minimum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Determines whether the minimum value in the filter value range should be included in the filtered results.
  - setIncludeMaximum
```
public void setIncludeMaximum(Boolean includeMaximum)
```
    Determines whether the maximum value in the filter value range should be included in the filtered results.
    
    Parameters:
    
    includeMaximum - Determines whether the maximum value in the filter value range should be included in the filtered results.
  - getIncludeMaximum
```
public Boolean getIncludeMaximum()
```
    Determines whether the maximum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Determines whether the maximum value in the filter value range should be included in the filtered results.
  - withIncludeMaximum
```
public TimeRangeFilter withIncludeMaximum(Boolean includeMaximum)
```
    Determines whether the maximum value in the filter value range should be included in the filtered results.
    
    Parameters:
    
    includeMaximum - Determines whether the maximum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeMaximum
```
public Boolean isIncludeMaximum()
```
    Determines whether the maximum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Determines whether the maximum value in the filter value range should be included in the filtered results.
  - setRangeMinimumValue
```
public void setRangeMinimumValue(TimeRangeFilterValue rangeMinimumValue)
```
    The minimum value for the filter value range.
    
    Parameters:
    
    rangeMinimumValue - The minimum value for the filter value range.
  - getRangeMinimumValue
```
public TimeRangeFilterValue getRangeMinimumValue()
```
    The minimum value for the filter value range.
    
    Returns:
    
    The minimum value for the filter value range.
  - withRangeMinimumValue
```
public TimeRangeFilter withRangeMinimumValue(TimeRangeFilterValue rangeMinimumValue)
```
    The minimum value for the filter value range.
    
    Parameters:
    
    rangeMinimumValue - The minimum value for the filter value range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeMaximumValue
```
public void setRangeMaximumValue(TimeRangeFilterValue rangeMaximumValue)
```
    The maximum value for the filter value range.
    
    Parameters:
    
    rangeMaximumValue - The maximum value for the filter value range.
  - getRangeMaximumValue
```
public TimeRangeFilterValue getRangeMaximumValue()
```
    The maximum value for the filter value range.
    
    Returns:
    
    The maximum value for the filter value range.
  - withRangeMaximumValue
```
public TimeRangeFilter withRangeMaximumValue(TimeRangeFilterValue rangeMaximumValue)
```
    The maximum value for the filter value range.
    
    Parameters:
    
    rangeMaximumValue - The maximum value for the filter value range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNullOption
```
public void setNullOption(String nullOption)
```
    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.
    Parameters:
    nullOption - 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:
    
    FilterNullOption
  - getNullOption
```
public 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.
    Returns:
    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:
    
    FilterNullOption
  - withNullOption
```
public TimeRangeFilter withNullOption(String nullOption)
```
    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.
    Parameters:
    nullOption - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FilterNullOption
  - withNullOption
```
public TimeRangeFilter withNullOption(FilterNullOption nullOption)
```
    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.
    Parameters:
    nullOption - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FilterNullOption
  - setExcludePeriodConfiguration
```
public void setExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)
```
    The exclude period of the time range filter.
    
    Parameters:
    
    excludePeriodConfiguration - The exclude period of the time range filter.
  - getExcludePeriodConfiguration
```
public ExcludePeriodConfiguration getExcludePeriodConfiguration()
```
    The exclude period of the time range filter.
    
    Returns:
    
    The exclude period of the time range filter.
  - withExcludePeriodConfiguration
```
public TimeRangeFilter withExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)
```
    The exclude period of the time range filter.
    
    Parameters:
    
    excludePeriodConfiguration - The exclude period of the time range filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeGranularity
```
public void setTimeGranularity(String timeGranularity)
```
    The level of time precision that is used to aggregate DateTime values.
    
    Parameters:
    
    timeGranularity - The level of time precision that is used to aggregate DateTime values.
    
    See Also:
    
    TimeGranularity
  - getTimeGranularity
```
public String getTimeGranularity()
```
    The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    The level of time precision that is used to aggregate DateTime values.
    
    See Also:
    
    TimeGranularity
  - withTimeGranularity
```
public TimeRangeFilter withTimeGranularity(String timeGranularity)
```
    The level of time precision that is used to aggregate DateTime values.
    
    Parameters:
    
    timeGranularity - The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - withTimeGranularity
```
public TimeRangeFilter withTimeGranularity(TimeGranularity timeGranularity)
```
    The level of time precision that is used to aggregate DateTime values.
    
    Parameters:
    
    timeGranularity - The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - setDefaultFilterControlConfiguration
```
public void setDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)
```
    The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Parameters:
    
    defaultFilterControlConfiguration - The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  - getDefaultFilterControlConfiguration
```
public DefaultFilterControlConfiguration getDefaultFilterControlConfiguration()
```
    The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Returns:
    
    The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  - withDefaultFilterControlConfiguration
```
public TimeRangeFilter withDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)
```
    The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Parameters:
    
    defaultFilterControlConfiguration - The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TimeRangeFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class TimeRangeFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimeRangeFilter

Method Detail

setFilterId

getFilterId

withFilterId

setColumn

getColumn

withColumn

setIncludeMinimum

getIncludeMinimum

withIncludeMinimum

isIncludeMinimum

setIncludeMaximum

getIncludeMaximum

withIncludeMaximum

isIncludeMaximum

setRangeMinimumValue

getRangeMinimumValue

withRangeMinimumValue

setRangeMaximumValue

getRangeMaximumValue

withRangeMaximumValue

setNullOption

getNullOption

withNullOption

withNullOption

setExcludePeriodConfiguration

getExcludePeriodConfiguration

withExcludePeriodConfiguration

setTimeGranularity

getTimeGranularity

withTimeGranularity

withTimeGranularity

setDefaultFilterControlConfiguration

getDefaultFilterControlConfiguration

withDefaultFilterControlConfiguration

toString

equals

hashCode

clone

marshall