com.amazonaws.services.quicksight.model

Class TopBottomFilter

java.lang.Object

com.amazonaws.services.quicksight.model.TopBottomFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TopBottomFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

A TopBottomFilter filters values that are at the top or the bottom.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TopBottomFilter()

Method Summary

Modifier and Type	Method and Description
TopBottomFilter	clone()
boolean	equals(Object obj)
List<AggregationSortConfiguration>	getAggregationSortConfigurations() The aggregation and sort configuration of the top bottom 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.
Integer	getLimit() The number of items to include in the top bottom filter results.
String	getParameterName() The parameter whose value should be used for the filter value.
String	getTimeGranularity() The level of time precision that is used to aggregate DateTime values.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations) The aggregation and sort configuration of the top bottom 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	setLimit(Integer limit) The number of items to include in the top bottom filter results.
void	setParameterName(String parameterName) The parameter whose value should be used for the filter value.
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.
TopBottomFilter	withAggregationSortConfigurations(AggregationSortConfiguration... aggregationSortConfigurations) The aggregation and sort configuration of the top bottom filter.
TopBottomFilter	withAggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations) The aggregation and sort configuration of the top bottom filter.
TopBottomFilter	withColumn(ColumnIdentifier column) The column that the filter is applied to.
TopBottomFilter	withFilterId(String filterId) An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
TopBottomFilter	withLimit(Integer limit) The number of items to include in the top bottom filter results.
TopBottomFilter	withParameterName(String parameterName) The parameter whose value should be used for the filter value.
TopBottomFilter	withTimeGranularity(String timeGranularity) The level of time precision that is used to aggregate DateTime values.
TopBottomFilter	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

TopBottomFilter

public TopBottomFilter()

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

setLimit

public void setLimit(Integer limit)

The number of items to include in the top bottom filter results.

Parameters:

limit - The number of items to include in the top bottom filter results.

getLimit

public Integer getLimit()

The number of items to include in the top bottom filter results.

Returns:

The number of items to include in the top bottom filter results.

withLimit

public TopBottomFilter withLimit(Integer limit)

The number of items to include in the top bottom filter results.

Parameters:

limit - The number of items to include in the top bottom filter results.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAggregationSortConfigurations

public List<AggregationSortConfiguration> getAggregationSortConfigurations()

The aggregation and sort configuration of the top bottom filter.

Returns:

The aggregation and sort configuration of the top bottom filter.

setAggregationSortConfigurations

public void setAggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations)

The aggregation and sort configuration of the top bottom filter.

Parameters:

aggregationSortConfigurations - The aggregation and sort configuration of the top bottom filter.

withAggregationSortConfigurations

public TopBottomFilter withAggregationSortConfigurations(AggregationSortConfiguration... aggregationSortConfigurations)

The aggregation and sort configuration of the top bottom filter.

NOTE: This method appends the values to the existing list (if any). Use setAggregationSortConfigurations(java.util.Collection) or withAggregationSortConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

aggregationSortConfigurations - The aggregation and sort configuration of the top bottom filter.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAggregationSortConfigurations

public TopBottomFilter withAggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations)

The aggregation and sort configuration of the top bottom filter.

Parameters:

aggregationSortConfigurations - The aggregation and sort configuration of the top bottom 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 TopBottomFilter 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 TopBottomFilter 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

setParameterName

public void setParameterName(String parameterName)

The parameter whose value should be used for the filter value.

Parameters:

parameterName - The parameter whose value should be used for the filter value.

getParameterName

public String getParameterName()

The parameter whose value should be used for the filter value.

Returns:

The parameter whose value should be used for the filter value.

withParameterName

public TopBottomFilter withParameterName(String parameterName)

The parameter whose value should be used for the filter value.

Parameters:

parameterName - The parameter whose value should be used for the filter value.

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 TopBottomFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo