software.amazon.awssdk.services.quicksight.model

Interface TopicFilter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TopicFilter.Builder,TopicFilter>, SdkBuilder<TopicFilter.Builder,TopicFilter>, SdkPojo

Enclosing class:

TopicFilter

public static interface TopicFilter.Builder
extends SdkPojo, CopyableBuilder<TopicFilter.Builder,TopicFilter>

Method Summary

Modifier and Type	Method and Description
default TopicFilter.Builder	categoryFilter(Consumer<TopicCategoryFilter.Builder> categoryFilter) The category filter that is associated with this filter.
TopicFilter.Builder	categoryFilter(TopicCategoryFilter categoryFilter) The category filter that is associated with this filter.
default TopicFilter.Builder	dateRangeFilter(Consumer<TopicDateRangeFilter.Builder> dateRangeFilter) The date range filter.
TopicFilter.Builder	dateRangeFilter(TopicDateRangeFilter dateRangeFilter) The date range filter.
TopicFilter.Builder	filterClass(FilterClass filterClass) The class of the filter.
TopicFilter.Builder	filterClass(String filterClass) The class of the filter.
TopicFilter.Builder	filterDescription(String filterDescription) A description of the filter used to select items for a topic.
TopicFilter.Builder	filterName(String filterName) The name of the filter.
TopicFilter.Builder	filterSynonyms(Collection<String> filterSynonyms) The other names or aliases for the filter.
TopicFilter.Builder	filterSynonyms(String... filterSynonyms) The other names or aliases for the filter.
TopicFilter.Builder	filterType(NamedFilterType filterType) The type of the filter.
TopicFilter.Builder	filterType(String filterType) The type of the filter.
default TopicFilter.Builder	numericEqualityFilter(Consumer<TopicNumericEqualityFilter.Builder> numericEqualityFilter) The numeric equality filter.
TopicFilter.Builder	numericEqualityFilter(TopicNumericEqualityFilter numericEqualityFilter) The numeric equality filter.
default TopicFilter.Builder	numericRangeFilter(Consumer<TopicNumericRangeFilter.Builder> numericRangeFilter) The numeric range filter.
TopicFilter.Builder	numericRangeFilter(TopicNumericRangeFilter numericRangeFilter) The numeric range filter.
TopicFilter.Builder	operandFieldName(String operandFieldName) The name of the field that the filter operates on.
default TopicFilter.Builder	relativeDateFilter(Consumer<TopicRelativeDateFilter.Builder> relativeDateFilter) The relative date filter.
TopicFilter.Builder	relativeDateFilter(TopicRelativeDateFilter relativeDateFilter) The relative date filter.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

filterDescription

TopicFilter.Builder filterDescription(String filterDescription)

A description of the filter used to select items for a topic.

Parameters:

filterDescription - A description of the filter used to select items for a topic.

Returns:

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

filterClass

TopicFilter.Builder filterClass(String filterClass)

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

Parameters:

filterClass - The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

Returns:

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

See Also:

FilterClass, FilterClass

filterClass

TopicFilter.Builder filterClass(FilterClass filterClass)

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

Parameters:

filterClass - The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

Returns:

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

See Also:

FilterClass, FilterClass

filterName

TopicFilter.Builder filterName(String filterName)

The name of the filter.

Parameters:

filterName - The name of the filter.

Returns:

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

filterSynonyms

TopicFilter.Builder filterSynonyms(Collection<String> filterSynonyms)

The other names or aliases for the filter.

Parameters:

filterSynonyms - The other names or aliases for the filter.

Returns:

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

filterSynonyms

TopicFilter.Builder filterSynonyms(String... filterSynonyms)

The other names or aliases for the filter.

Parameters:

filterSynonyms - The other names or aliases for the filter.

Returns:

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

operandFieldName

TopicFilter.Builder operandFieldName(String operandFieldName)

The name of the field that the filter operates on.

Parameters:

operandFieldName - The name of the field that the filter operates on.

Returns:

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

filterType

TopicFilter.Builder filterType(String filterType)

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

Parameters:

filterType - The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

Returns:

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

See Also:

NamedFilterType, NamedFilterType

filterType

TopicFilter.Builder filterType(NamedFilterType filterType)

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

Parameters:

filterType - The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

Returns:

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

See Also:

NamedFilterType, NamedFilterType

categoryFilter

TopicFilter.Builder categoryFilter(TopicCategoryFilter categoryFilter)

The category filter that is associated with this filter.

Parameters:

categoryFilter - The category filter that is associated with this filter.

Returns:

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

categoryFilter

default TopicFilter.Builder categoryFilter(Consumer<TopicCategoryFilter.Builder> categoryFilter)

The category filter that is associated with this filter.

This is a convenience method that creates an instance of the TopicCategoryFilter.Builder avoiding the need to create one manually via TopicCategoryFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to categoryFilter(TopicCategoryFilter).

Parameters:

categoryFilter - a consumer that will call methods on TopicCategoryFilter.Builder

Returns:

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

See Also:

categoryFilter(TopicCategoryFilter)

numericEqualityFilter

TopicFilter.Builder numericEqualityFilter(TopicNumericEqualityFilter numericEqualityFilter)

The numeric equality filter.

Parameters:

numericEqualityFilter - The numeric equality filter.

Returns:

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

numericEqualityFilter

default TopicFilter.Builder numericEqualityFilter(Consumer<TopicNumericEqualityFilter.Builder> numericEqualityFilter)

The numeric equality filter.

This is a convenience method that creates an instance of the TopicNumericEqualityFilter.Builder avoiding the need to create one manually via TopicNumericEqualityFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to numericEqualityFilter(TopicNumericEqualityFilter).

Parameters:

numericEqualityFilter - a consumer that will call methods on TopicNumericEqualityFilter.Builder

Returns:

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

See Also:

numericEqualityFilter(TopicNumericEqualityFilter)

numericRangeFilter

TopicFilter.Builder numericRangeFilter(TopicNumericRangeFilter numericRangeFilter)

The numeric range filter.

Parameters:

numericRangeFilter - The numeric range filter.

Returns:

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

numericRangeFilter

default TopicFilter.Builder numericRangeFilter(Consumer<TopicNumericRangeFilter.Builder> numericRangeFilter)

The numeric range filter.

This is a convenience method that creates an instance of the TopicNumericRangeFilter.Builder avoiding the need to create one manually via TopicNumericRangeFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to numericRangeFilter(TopicNumericRangeFilter).

Parameters:

numericRangeFilter - a consumer that will call methods on TopicNumericRangeFilter.Builder

Returns:

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

See Also:

numericRangeFilter(TopicNumericRangeFilter)

dateRangeFilter

TopicFilter.Builder dateRangeFilter(TopicDateRangeFilter dateRangeFilter)

The date range filter.

Parameters:

dateRangeFilter - The date range filter.

Returns:

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

dateRangeFilter

default TopicFilter.Builder dateRangeFilter(Consumer<TopicDateRangeFilter.Builder> dateRangeFilter)

The date range filter.

This is a convenience method that creates an instance of the TopicDateRangeFilter.Builder avoiding the need to create one manually via TopicDateRangeFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dateRangeFilter(TopicDateRangeFilter).

Parameters:

dateRangeFilter - a consumer that will call methods on TopicDateRangeFilter.Builder

Returns:

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

See Also:

dateRangeFilter(TopicDateRangeFilter)

relativeDateFilter

TopicFilter.Builder relativeDateFilter(TopicRelativeDateFilter relativeDateFilter)

The relative date filter.

Parameters:

relativeDateFilter - The relative date filter.

Returns:

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

relativeDateFilter

default TopicFilter.Builder relativeDateFilter(Consumer<TopicRelativeDateFilter.Builder> relativeDateFilter)

The relative date filter.

This is a convenience method that creates an instance of the TopicRelativeDateFilter.Builder avoiding the need to create one manually via TopicRelativeDateFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to relativeDateFilter(TopicRelativeDateFilter).

Parameters:

relativeDateFilter - a consumer that will call methods on TopicRelativeDateFilter.Builder

Returns:

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

See Also:

relativeDateFilter(TopicRelativeDateFilter)