NumericRangeFilter (AWS Java SDK for Amazon QuickSight 1.12.770 API)

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NumericRangeFilter()

Constructors
Constructor and Description
`NumericRangeFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NumericRangeFilter`	`clone()`
`boolean`	`equals(Object obj)`
`AggregationFunction`	`getAggregationFunction()` The aggregation function of the filter.
`ColumnIdentifier`	`getColumn()` The column that the filter is applied to.
`DefaultFilterControlConfiguration`	`getDefaultFilterControlConfiguration()` The default configurations for the associated controls.
`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.
`NumericRangeFilterValue`	`getRangeMaximum()` The maximum value for the filter value range.
`NumericRangeFilterValue`	`getRangeMinimum()` The minimum value for the filter value range.
`String`	`getSelectAllOptions()` Select all of the 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`	`setAggregationFunction(AggregationFunction aggregationFunction)` The aggregation function of the filter.
`void`	`setColumn(ColumnIdentifier column)` The column that the filter is applied to.
`void`	`setDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)` The default configurations for the associated controls.
`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`	`setRangeMaximum(NumericRangeFilterValue rangeMaximum)` The maximum value for the filter value range.
`void`	`setRangeMinimum(NumericRangeFilterValue rangeMinimum)` The minimum value for the filter value range.
`void`	`setSelectAllOptions(String selectAllOptions)` Select all of the values.
`String`	`toString()` Returns a string representation of this object.
`NumericRangeFilter`	`withAggregationFunction(AggregationFunction aggregationFunction)` The aggregation function of the filter.
`NumericRangeFilter`	`withColumn(ColumnIdentifier column)` The column that the filter is applied to.
`NumericRangeFilter`	`withDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)` The default configurations for the associated controls.
`NumericRangeFilter`	`withFilterId(String filterId)` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`NumericRangeFilter`	`withIncludeMaximum(Boolean includeMaximum)` Determines whether the maximum value in the filter value range should be included in the filtered results.
`NumericRangeFilter`	`withIncludeMinimum(Boolean includeMinimum)` Determines whether the minimum value in the filter value range should be included in the filtered results.
`NumericRangeFilter`	`withNullOption(FilterNullOption nullOption)` This option determines how null values should be treated when filtering data.
`NumericRangeFilter`	`withNullOption(String nullOption)` This option determines how null values should be treated when filtering data.
`NumericRangeFilter`	`withRangeMaximum(NumericRangeFilterValue rangeMaximum)` The maximum value for the filter value range.
`NumericRangeFilter`	`withRangeMinimum(NumericRangeFilterValue rangeMinimum)` The minimum value for the filter value range.
`NumericRangeFilter`	`withSelectAllOptions(NumericFilterSelectAllOptions selectAllOptions)` Select all of the values.
`NumericRangeFilter`	`withSelectAllOptions(String selectAllOptions)` Select all of the values.

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

- Constructor Detail
  - NumericRangeFilter
```
public NumericRangeFilter()
```
- 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 NumericRangeFilter 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 NumericRangeFilter 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 NumericRangeFilter 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 NumericRangeFilter 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.
  - setRangeMinimum
```
public void setRangeMinimum(NumericRangeFilterValue rangeMinimum)
```
    The minimum value for the filter value range.
    
    Parameters:
    
    rangeMinimum - The minimum value for the filter value range.
  - getRangeMinimum
```
public NumericRangeFilterValue getRangeMinimum()
```
    The minimum value for the filter value range.
    
    Returns:
    
    The minimum value for the filter value range.
  - withRangeMinimum
```
public NumericRangeFilter withRangeMinimum(NumericRangeFilterValue rangeMinimum)
```
    The minimum value for the filter value range.
    
    Parameters:
    
    rangeMinimum - The minimum value for the filter value range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRangeMaximum
```
public void setRangeMaximum(NumericRangeFilterValue rangeMaximum)
```
    The maximum value for the filter value range.
    
    Parameters:
    
    rangeMaximum - The maximum value for the filter value range.
  - getRangeMaximum
```
public NumericRangeFilterValue getRangeMaximum()
```
    The maximum value for the filter value range.
    
    Returns:
    
    The maximum value for the filter value range.
  - withRangeMaximum
```
public NumericRangeFilter withRangeMaximum(NumericRangeFilterValue rangeMaximum)
```
    The maximum value for the filter value range.
    
    Parameters:
    
    rangeMaximum - The maximum value for the filter value range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSelectAllOptions
```
public void setSelectAllOptions(String selectAllOptions)
```
    Select all of the values. Null is not the assigned value of select all.
    - FILTER_ALL_VALUES
    Parameters:
    selectAllOptions - Select all of the values. Null is not the assigned value of select all.
    
    FILTER_ALL_VALUES
    See Also:
    
    NumericFilterSelectAllOptions
  - getSelectAllOptions
```
public String getSelectAllOptions()
```
    Select all of the values. Null is not the assigned value of select all.
    - FILTER_ALL_VALUES
    Returns:
    Select all of the values. Null is not the assigned value of select all.
    
    FILTER_ALL_VALUES
    See Also:
    
    NumericFilterSelectAllOptions
  - withSelectAllOptions
```
public NumericRangeFilter withSelectAllOptions(String selectAllOptions)
```
    Select all of the values. Null is not the assigned value of select all.
    - FILTER_ALL_VALUES
    Parameters:
    selectAllOptions - Select all of the values. Null is not the assigned value of select all.
    
    FILTER_ALL_VALUES
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NumericFilterSelectAllOptions
  - withSelectAllOptions
```
public NumericRangeFilter withSelectAllOptions(NumericFilterSelectAllOptions selectAllOptions)
```
    Select all of the values. Null is not the assigned value of select all.
    - FILTER_ALL_VALUES
    Parameters:
    selectAllOptions - Select all of the values. Null is not the assigned value of select all.
    
    FILTER_ALL_VALUES
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NumericFilterSelectAllOptions
  - setAggregationFunction
```
public void setAggregationFunction(AggregationFunction aggregationFunction)
```
    The aggregation function of the filter.
    
    Parameters:
    
    aggregationFunction - The aggregation function of the filter.
  - getAggregationFunction
```
public AggregationFunction getAggregationFunction()
```
    The aggregation function of the filter.
    
    Returns:
    
    The aggregation function of the filter.
  - withAggregationFunction
```
public NumericRangeFilter withAggregationFunction(AggregationFunction aggregationFunction)
```
    The aggregation function of the filter.
    
    Parameters:
    
    aggregationFunction - The aggregation function of the filter.
    
    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 NumericRangeFilter 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 NumericRangeFilter 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
  - 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 NumericRangeFilter 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 NumericRangeFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class NumericRangeFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NumericRangeFilter

Method Detail

setFilterId

getFilterId

withFilterId

setColumn

getColumn

withColumn

setIncludeMinimum

getIncludeMinimum

withIncludeMinimum

isIncludeMinimum

setIncludeMaximum

getIncludeMaximum

withIncludeMaximum

isIncludeMaximum

setRangeMinimum

getRangeMinimum

withRangeMinimum

setRangeMaximum

getRangeMaximum

withRangeMaximum

setSelectAllOptions

getSelectAllOptions

withSelectAllOptions

withSelectAllOptions

setAggregationFunction

getAggregationFunction

withAggregationFunction

setNullOption

getNullOption

withNullOption

withNullOption

setDefaultFilterControlConfiguration

getDefaultFilterControlConfiguration

withDefaultFilterControlConfiguration

toString

equals

hashCode

clone

marshall