com.amazonaws.services.quicksight.model

Class TopicNumericRangeFilter

java.lang.Object

com.amazonaws.services.quicksight.model.TopicNumericRangeFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TopicNumericRangeFilter()

Method Summary

Modifier and Type	Method and Description
TopicNumericRangeFilter	clone()
boolean	equals(Object obj)
String	getAggregation() An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
TopicRangeFilterConstant	getConstant() The constant used in a numeric range filter.
Boolean	getInclusive() A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.
int	hashCode()
Boolean	isInclusive() A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAggregation(String aggregation) An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
void	setConstant(TopicRangeFilterConstant constant) The constant used in a numeric range filter.
void	setInclusive(Boolean inclusive) A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.
String	toString() Returns a string representation of this object.
TopicNumericRangeFilter	withAggregation(NamedFilterAggType aggregation) An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
TopicNumericRangeFilter	withAggregation(String aggregation) An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
TopicNumericRangeFilter	withConstant(TopicRangeFilterConstant constant) The constant used in a numeric range filter.
TopicNumericRangeFilter	withInclusive(Boolean inclusive) A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TopicNumericRangeFilter

public TopicNumericRangeFilter()

Method Detail

setInclusive

public void setInclusive(Boolean inclusive)

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Parameters:

inclusive - A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

getInclusive

public Boolean getInclusive()

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Returns:

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

withInclusive

public TopicNumericRangeFilter withInclusive(Boolean inclusive)

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Parameters:

inclusive - A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Returns:

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

isInclusive

public Boolean isInclusive()

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Returns:

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

setConstant

public void setConstant(TopicRangeFilterConstant constant)

The constant used in a numeric range filter.

Parameters:

constant - The constant used in a numeric range filter.

getConstant

public TopicRangeFilterConstant getConstant()

The constant used in a numeric range filter.

Returns:

The constant used in a numeric range filter.

withConstant

public TopicNumericRangeFilter withConstant(TopicRangeFilterConstant constant)

The constant used in a numeric range filter.

Parameters:

constant - The constant used in a numeric range filter.

Returns:

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

setAggregation

public void setAggregation(String aggregation)

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

Parameters:

aggregation - An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

See Also:

NamedFilterAggType

getAggregation

public String getAggregation()

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

Returns:

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

See Also:

NamedFilterAggType

withAggregation

public TopicNumericRangeFilter withAggregation(String aggregation)

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

Parameters:

aggregation - An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

Returns:

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

See Also:

NamedFilterAggType

withAggregation

public TopicNumericRangeFilter withAggregation(NamedFilterAggType aggregation)

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

Parameters:

aggregation - An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

Returns:

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

See Also:

NamedFilterAggType

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo