com.amazonaws.services.quicksight.model

Class CustomFilterConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.CustomFilterConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A custom filter that filters based on a single value. This filter can be partially matched.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomFilterConfiguration()

Method Summary

Modifier and Type	Method and Description
CustomFilterConfiguration	clone()
boolean	equals(Object obj)
String	getCategoryValue() The category value for the filter.
String	getMatchOperator() The match operator that is used to determine if a filter should be applied.
String	getNullOption() This option determines how null values should be treated when filtering data.
String	getParameterName() The parameter whose value should be used for the filter value.
String	getSelectAllOptions() Select all of the values.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCategoryValue(String categoryValue) The category value for the filter.
void	setMatchOperator(String matchOperator) The match operator that is used to determine if a filter should be applied.
void	setNullOption(String nullOption) This option determines how null values should be treated when filtering data.
void	setParameterName(String parameterName) The parameter whose value should be used for the filter value.
void	setSelectAllOptions(String selectAllOptions) Select all of the values.
String	toString() Returns a string representation of this object.
CustomFilterConfiguration	withCategoryValue(String categoryValue) The category value for the filter.
CustomFilterConfiguration	withMatchOperator(CategoryFilterMatchOperator matchOperator) The match operator that is used to determine if a filter should be applied.
CustomFilterConfiguration	withMatchOperator(String matchOperator) The match operator that is used to determine if a filter should be applied.
CustomFilterConfiguration	withNullOption(FilterNullOption nullOption) This option determines how null values should be treated when filtering data.
CustomFilterConfiguration	withNullOption(String nullOption) This option determines how null values should be treated when filtering data.
CustomFilterConfiguration	withParameterName(String parameterName) The parameter whose value should be used for the filter value.
CustomFilterConfiguration	withSelectAllOptions(CategoryFilterSelectAllOptions selectAllOptions) Select all of the values.
CustomFilterConfiguration	withSelectAllOptions(String selectAllOptions) Select all of the values.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFilterConfiguration

public CustomFilterConfiguration()

Method Detail

setMatchOperator

public void setMatchOperator(String matchOperator)

The match operator that is used to determine if a filter should be applied.

Parameters:

matchOperator - The match operator that is used to determine if a filter should be applied.

See Also:

CategoryFilterMatchOperator

getMatchOperator

public String getMatchOperator()

The match operator that is used to determine if a filter should be applied.

Returns:

The match operator that is used to determine if a filter should be applied.

See Also:

CategoryFilterMatchOperator

withMatchOperator

public CustomFilterConfiguration withMatchOperator(String matchOperator)

The match operator that is used to determine if a filter should be applied.

Parameters:

matchOperator - The match operator that is used to determine if a filter should be applied.

Returns:

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

See Also:

CategoryFilterMatchOperator

withMatchOperator

public CustomFilterConfiguration withMatchOperator(CategoryFilterMatchOperator matchOperator)

The match operator that is used to determine if a filter should be applied.

Parameters:

matchOperator - The match operator that is used to determine if a filter should be applied.

Returns:

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

See Also:

CategoryFilterMatchOperator

setCategoryValue

public void setCategoryValue(String categoryValue)

The category value for the filter.

This field is mutually exclusive to ParameterName.

Parameters:

categoryValue - The category value for the filter.

This field is mutually exclusive to ParameterName.

getCategoryValue

public String getCategoryValue()

The category value for the filter.

This field is mutually exclusive to ParameterName.

Returns:

The category value for the filter.

This field is mutually exclusive to ParameterName.

withCategoryValue

public CustomFilterConfiguration withCategoryValue(String categoryValue)

The category value for the filter.

This field is mutually exclusive to ParameterName.

Parameters:

categoryValue - The category value for the filter.

This field is mutually exclusive to ParameterName.

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:

CategoryFilterSelectAllOptions

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:

CategoryFilterSelectAllOptions

withSelectAllOptions

public CustomFilterConfiguration 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:

CategoryFilterSelectAllOptions

withSelectAllOptions

public CustomFilterConfiguration withSelectAllOptions(CategoryFilterSelectAllOptions 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:

CategoryFilterSelectAllOptions

setParameterName

public void setParameterName(String parameterName)

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

This field is mutually exclusive to CategoryValue.

Parameters:

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

This field is mutually exclusive to CategoryValue.

getParameterName

public String getParameterName()

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

This field is mutually exclusive to CategoryValue.

Returns:

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

This field is mutually exclusive to CategoryValue.

withParameterName

public CustomFilterConfiguration withParameterName(String parameterName)

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

This field is mutually exclusive to CategoryValue.

Parameters:

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

This field is mutually exclusive to CategoryValue.

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 CustomFilterConfiguration 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 CustomFilterConfiguration 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

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo