Filter (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Filter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
With a Filter, you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Filter()

Constructors
Constructor and Description
`Filter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Filter`	`clone()`
`boolean`	`equals(Object obj)`
`CategoryFilter`	`getCategoryFilter()` A `CategoryFilter` filters text values.
`NestedFilter`	`getNestedFilter()` A `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.
`NumericEqualityFilter`	`getNumericEqualityFilter()` A `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.
`NumericRangeFilter`	`getNumericRangeFilter()` A `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.
`RelativeDatesFilter`	`getRelativeDatesFilter()` A `RelativeDatesFilter` filters date values that are relative to a given date.
`TimeEqualityFilter`	`getTimeEqualityFilter()` A `TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value.
`TimeRangeFilter`	`getTimeRangeFilter()` A `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.
`TopBottomFilter`	`getTopBottomFilter()` A `TopBottomFilter` filters data to the top or bottom values for a given column.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCategoryFilter(CategoryFilter categoryFilter)` A `CategoryFilter` filters text values.
`void`	`setNestedFilter(NestedFilter nestedFilter)` A `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.
`void`	`setNumericEqualityFilter(NumericEqualityFilter numericEqualityFilter)` A `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.
`void`	`setNumericRangeFilter(NumericRangeFilter numericRangeFilter)` A `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.
`void`	`setRelativeDatesFilter(RelativeDatesFilter relativeDatesFilter)` A `RelativeDatesFilter` filters date values that are relative to a given date.
`void`	`setTimeEqualityFilter(TimeEqualityFilter timeEqualityFilter)` A `TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value.
`void`	`setTimeRangeFilter(TimeRangeFilter timeRangeFilter)` A `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.
`void`	`setTopBottomFilter(TopBottomFilter topBottomFilter)` A `TopBottomFilter` filters data to the top or bottom values for a given column.
`String`	`toString()` Returns a string representation of this object.
`Filter`	`withCategoryFilter(CategoryFilter categoryFilter)` A `CategoryFilter` filters text values.
`Filter`	`withNestedFilter(NestedFilter nestedFilter)` A `NestedFilter` filters data with a subset of data that is defined by the nested inner filter.
`Filter`	`withNumericEqualityFilter(NumericEqualityFilter numericEqualityFilter)` A `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.
`Filter`	`withNumericRangeFilter(NumericRangeFilter numericRangeFilter)` A `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.
`Filter`	`withRelativeDatesFilter(RelativeDatesFilter relativeDatesFilter)` A `RelativeDatesFilter` filters date values that are relative to a given date.
`Filter`	`withTimeEqualityFilter(TimeEqualityFilter timeEqualityFilter)` A `TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value.
`Filter`	`withTimeRangeFilter(TimeRangeFilter timeRangeFilter)` A `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.
`Filter`	`withTopBottomFilter(TopBottomFilter topBottomFilter)` A `TopBottomFilter` filters data to the top or bottom values for a given column.

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

- Constructor Detail
  - Filter
```
public Filter()
```
- Method Detail
  - setCategoryFilter
```
public void setCategoryFilter(CategoryFilter categoryFilter)
```
    A CategoryFilter filters text values.
    
    For more information, see Adding text filters in the Amazon QuickSight User Guide.
    
    Parameters:
    
    categoryFilter - A CategoryFilter filters text values.
    
    For more information, see Adding text filters in the Amazon QuickSight User Guide.
  - getCategoryFilter
```
public CategoryFilter getCategoryFilter()
```
    A CategoryFilter filters text values.
    
    For more information, see Adding text filters in the Amazon QuickSight User Guide.
    
    Returns:
    
    A CategoryFilter filters text values.
    
    For more information, see Adding text filters in the Amazon QuickSight User Guide.
  - withCategoryFilter
```
public Filter withCategoryFilter(CategoryFilter categoryFilter)
```
    A CategoryFilter filters text values.
    
    For more information, see Adding text filters in the Amazon QuickSight User Guide.
    
    Parameters:
    
    categoryFilter - A CategoryFilter filters text values.
    
    For more information, see Adding text filters in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumericRangeFilter
```
public void setNumericRangeFilter(NumericRangeFilter numericRangeFilter)
```
    A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
    
    Parameters:
    
    numericRangeFilter - A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
  - getNumericRangeFilter
```
public NumericRangeFilter getNumericRangeFilter()
```
    A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
    
    Returns:
    
    A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
  - withNumericRangeFilter
```
public Filter withNumericRangeFilter(NumericRangeFilter numericRangeFilter)
```
    A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
    
    Parameters:
    
    numericRangeFilter - A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumericEqualityFilter
```
public void setNumericEqualityFilter(NumericEqualityFilter numericEqualityFilter)
```
    A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
    
    Parameters:
    
    numericEqualityFilter - A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
  - getNumericEqualityFilter
```
public NumericEqualityFilter getNumericEqualityFilter()
```
    A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
    
    Returns:
    
    A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
  - withNumericEqualityFilter
```
public Filter withNumericEqualityFilter(NumericEqualityFilter numericEqualityFilter)
```
    A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
    
    Parameters:
    
    numericEqualityFilter - A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeEqualityFilter
```
public void setTimeEqualityFilter(TimeEqualityFilter timeEqualityFilter)
```
    A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
    
    Parameters:
    
    timeEqualityFilter - A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
  - getTimeEqualityFilter
```
public TimeEqualityFilter getTimeEqualityFilter()
```
    A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
    
    Returns:
    
    A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
  - withTimeEqualityFilter
```
public Filter withTimeEqualityFilter(TimeEqualityFilter timeEqualityFilter)
```
    A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
    
    Parameters:
    
    timeEqualityFilter - A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeRangeFilter
```
public void setTimeRangeFilter(TimeRangeFilter timeRangeFilter)
```
    A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
    
    Parameters:
    
    timeRangeFilter - A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
  - getTimeRangeFilter
```
public TimeRangeFilter getTimeRangeFilter()
```
    A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
    
    Returns:
    
    A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
  - withTimeRangeFilter
```
public Filter withTimeRangeFilter(TimeRangeFilter timeRangeFilter)
```
    A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
    
    Parameters:
    
    timeRangeFilter - A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRelativeDatesFilter
```
public void setRelativeDatesFilter(RelativeDatesFilter relativeDatesFilter)
```
    A RelativeDatesFilter filters date values that are relative to a given date.
    
    Parameters:
    
    relativeDatesFilter - A RelativeDatesFilter filters date values that are relative to a given date.
  - getRelativeDatesFilter
```
public RelativeDatesFilter getRelativeDatesFilter()
```
    A RelativeDatesFilter filters date values that are relative to a given date.
    
    Returns:
    
    A RelativeDatesFilter filters date values that are relative to a given date.
  - withRelativeDatesFilter
```
public Filter withRelativeDatesFilter(RelativeDatesFilter relativeDatesFilter)
```
    A RelativeDatesFilter filters date values that are relative to a given date.
    
    Parameters:
    
    relativeDatesFilter - A RelativeDatesFilter filters date values that are relative to a given date.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTopBottomFilter
```
public void setTopBottomFilter(TopBottomFilter topBottomFilter)
```
    A TopBottomFilter filters data to the top or bottom values for a given column.
    
    Parameters:
    
    topBottomFilter - A TopBottomFilter filters data to the top or bottom values for a given column.
  - getTopBottomFilter
```
public TopBottomFilter getTopBottomFilter()
```
    A TopBottomFilter filters data to the top or bottom values for a given column.
    
    Returns:
    
    A TopBottomFilter filters data to the top or bottom values for a given column.
  - withTopBottomFilter
```
public Filter withTopBottomFilter(TopBottomFilter topBottomFilter)
```
    A TopBottomFilter filters data to the top or bottom values for a given column.
    
    Parameters:
    
    topBottomFilter - A TopBottomFilter filters data to the top or bottom values for a given column.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNestedFilter
```
public void setNestedFilter(NestedFilter nestedFilter)
```
    A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
    
    Parameters:
    
    nestedFilter - A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
  - getNestedFilter
```
public NestedFilter getNestedFilter()
```
    A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
    
    Returns:
    
    A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
  - withNestedFilter
```
public Filter withNestedFilter(NestedFilter nestedFilter)
```
    A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
    
    Parameters:
    
    nestedFilter - A NestedFilter filters data with a subset of data that is defined by the nested inner filter.
    
    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 Filter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class Filter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Filter

Method Detail

setCategoryFilter

getCategoryFilter

withCategoryFilter

setNumericRangeFilter

getNumericRangeFilter

withNumericRangeFilter

setNumericEqualityFilter

getNumericEqualityFilter

withNumericEqualityFilter

setTimeEqualityFilter

getTimeEqualityFilter

withTimeEqualityFilter

setTimeRangeFilter

getTimeRangeFilter

withTimeRangeFilter

setRelativeDatesFilter

getRelativeDatesFilter

withRelativeDatesFilter

setTopBottomFilter

getTopBottomFilter

withTopBottomFilter

setNestedFilter

getNestedFilter

withNestedFilter

toString

equals

hashCode

clone

marshall