@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.
Constructor and Description |
---|
NumericRangeFilter() |
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.
|
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAggregationFunction(AggregationFunction aggregationFunction)
The aggregation function of the filter.
|
void |
setColumn(ColumnIdentifier column)
The column that the filter is applied to.
|
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 |
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.
|
public void setFilterId(String filterId)
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
filterId
- An identifier that uniquely identifies a filter within a dashboard, analysis, or template.public String getFilterId()
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
public NumericRangeFilter withFilterId(String filterId)
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
filterId
- An identifier that uniquely identifies a filter within a dashboard, analysis, or template.public void setColumn(ColumnIdentifier column)
The column that the filter is applied to.
column
- The column that the filter is applied to.public ColumnIdentifier getColumn()
The column that the filter is applied to.
public NumericRangeFilter withColumn(ColumnIdentifier column)
The column that the filter is applied to.
column
- The column that the filter is applied to.public void setIncludeMinimum(Boolean includeMinimum)
Determines whether the minimum value in the filter value range should be included in the filtered results.
includeMinimum
- Determines whether the minimum value in the filter value range should be included in the filtered results.public Boolean getIncludeMinimum()
Determines whether the minimum value in the filter value range should be included in the filtered results.
public NumericRangeFilter withIncludeMinimum(Boolean includeMinimum)
Determines whether the minimum value in the filter value range should be included in the filtered results.
includeMinimum
- Determines whether the minimum value in the filter value range should be included in the filtered results.public Boolean isIncludeMinimum()
Determines whether the minimum value in the filter value range should be included in the filtered results.
public void setIncludeMaximum(Boolean includeMaximum)
Determines whether the maximum value in the filter value range should be included in the filtered results.
includeMaximum
- Determines whether the maximum value in the filter value range should be included in the filtered results.public Boolean getIncludeMaximum()
Determines whether the maximum value in the filter value range should be included in the filtered results.
public NumericRangeFilter withIncludeMaximum(Boolean includeMaximum)
Determines whether the maximum value in the filter value range should be included in the filtered results.
includeMaximum
- Determines whether the maximum value in the filter value range should be included in the filtered results.public Boolean isIncludeMaximum()
Determines whether the maximum value in the filter value range should be included in the filtered results.
public void setRangeMinimum(NumericRangeFilterValue rangeMinimum)
The minimum value for the filter value range.
rangeMinimum
- The minimum value for the filter value range.public NumericRangeFilterValue getRangeMinimum()
The minimum value for the filter value range.
public NumericRangeFilter withRangeMinimum(NumericRangeFilterValue rangeMinimum)
The minimum value for the filter value range.
rangeMinimum
- The minimum value for the filter value range.public void setRangeMaximum(NumericRangeFilterValue rangeMaximum)
The maximum value for the filter value range.
rangeMaximum
- The maximum value for the filter value range.public NumericRangeFilterValue getRangeMaximum()
The maximum value for the filter value range.
public NumericRangeFilter withRangeMaximum(NumericRangeFilterValue rangeMaximum)
The maximum value for the filter value range.
rangeMaximum
- The maximum value for the filter value range.public void setSelectAllOptions(String selectAllOptions)
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
selectAllOptions
- Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
NumericFilterSelectAllOptions
public String getSelectAllOptions()
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
FILTER_ALL_VALUES
NumericFilterSelectAllOptions
public NumericRangeFilter withSelectAllOptions(String selectAllOptions)
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
selectAllOptions
- Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
NumericFilterSelectAllOptions
public NumericRangeFilter withSelectAllOptions(NumericFilterSelectAllOptions selectAllOptions)
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
selectAllOptions
- Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
NumericFilterSelectAllOptions
public void setAggregationFunction(AggregationFunction aggregationFunction)
The aggregation function of the filter.
aggregationFunction
- The aggregation function of the filter.public AggregationFunction getAggregationFunction()
The aggregation function of the filter.
public NumericRangeFilter withAggregationFunction(AggregationFunction aggregationFunction)
The aggregation function of the filter.
aggregationFunction
- The aggregation function of the filter.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.
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.
FilterNullOption
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.
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.
FilterNullOption
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.
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.
FilterNullOption
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.
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.
FilterNullOption
public String toString()
toString
in class Object
Object.toString()
public NumericRangeFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.