Interface Filter.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Filter.Builder,Filter>,SdkBuilder<Filter.Builder,Filter>,SdkPojo
- Enclosing class:
- Filter
@Mutable @NotThreadSafe public static interface Filter.Builder extends SdkPojo, CopyableBuilder<Filter.Builder,Filter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Filter.BuildercategoryFilter(Consumer<CategoryFilter.Builder> categoryFilter)ACategoryFilterfilters text values.Filter.BuildercategoryFilter(CategoryFilter categoryFilter)ACategoryFilterfilters text values.default Filter.BuildernestedFilter(Consumer<NestedFilter.Builder> nestedFilter)ANestedFilterfilters data with a subset of data that is defined by the nested inner filter.Filter.BuildernestedFilter(NestedFilter nestedFilter)ANestedFilterfilters data with a subset of data that is defined by the nested inner filter.default Filter.BuildernumericEqualityFilter(Consumer<NumericEqualityFilter.Builder> numericEqualityFilter)ANumericEqualityFilterfilters numeric values that equal or do not equal a given numeric value.Filter.BuildernumericEqualityFilter(NumericEqualityFilter numericEqualityFilter)ANumericEqualityFilterfilters numeric values that equal or do not equal a given numeric value.default Filter.BuildernumericRangeFilter(Consumer<NumericRangeFilter.Builder> numericRangeFilter)ANumericRangeFilterfilters numeric values that are either inside or outside a given numeric range.Filter.BuildernumericRangeFilter(NumericRangeFilter numericRangeFilter)ANumericRangeFilterfilters numeric values that are either inside or outside a given numeric range.default Filter.BuilderrelativeDatesFilter(Consumer<RelativeDatesFilter.Builder> relativeDatesFilter)ARelativeDatesFilterfilters date values that are relative to a given date.Filter.BuilderrelativeDatesFilter(RelativeDatesFilter relativeDatesFilter)ARelativeDatesFilterfilters date values that are relative to a given date.default Filter.BuildertimeEqualityFilter(Consumer<TimeEqualityFilter.Builder> timeEqualityFilter)ATimeEqualityFilterfilters date-time values that equal or do not equal a given date/time value.Filter.BuildertimeEqualityFilter(TimeEqualityFilter timeEqualityFilter)ATimeEqualityFilterfilters date-time values that equal or do not equal a given date/time value.default Filter.BuildertimeRangeFilter(Consumer<TimeRangeFilter.Builder> timeRangeFilter)ATimeRangeFilterfilters date-time values that are either inside or outside a given date/time range.Filter.BuildertimeRangeFilter(TimeRangeFilter timeRangeFilter)ATimeRangeFilterfilters date-time values that are either inside or outside a given date/time range.default Filter.BuildertopBottomFilter(Consumer<TopBottomFilter.Builder> topBottomFilter)ATopBottomFilterfilters data to the top or bottom values for a given column.Filter.BuildertopBottomFilter(TopBottomFilter topBottomFilter)ATopBottomFilterfilters data to the top or bottom values for a given column.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
categoryFilter
Filter.Builder categoryFilter(CategoryFilter categoryFilter)
A
CategoryFilterfilters text values.For more information, see Adding text filters in the Amazon QuickSight User Guide.
- Parameters:
categoryFilter- ACategoryFilterfilters 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.
-
categoryFilter
default Filter.Builder categoryFilter(Consumer<CategoryFilter.Builder> categoryFilter)
A
CategoryFilterfilters text values.For more information, see Adding text filters in the Amazon QuickSight User Guide.
This is a convenience method that creates an instance of theCategoryFilter.Builderavoiding the need to create one manually viaCategoryFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocategoryFilter(CategoryFilter).- Parameters:
categoryFilter- a consumer that will call methods onCategoryFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
categoryFilter(CategoryFilter)
-
numericRangeFilter
Filter.Builder numericRangeFilter(NumericRangeFilter numericRangeFilter)
A
NumericRangeFilterfilters numeric values that are either inside or outside a given numeric range.- Parameters:
numericRangeFilter- ANumericRangeFilterfilters 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.
-
numericRangeFilter
default Filter.Builder numericRangeFilter(Consumer<NumericRangeFilter.Builder> numericRangeFilter)
A
This is a convenience method that creates an instance of theNumericRangeFilterfilters numeric values that are either inside or outside a given numeric range.NumericRangeFilter.Builderavoiding the need to create one manually viaNumericRangeFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tonumericRangeFilter(NumericRangeFilter).- Parameters:
numericRangeFilter- a consumer that will call methods onNumericRangeFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
numericRangeFilter(NumericRangeFilter)
-
numericEqualityFilter
Filter.Builder numericEqualityFilter(NumericEqualityFilter numericEqualityFilter)
A
NumericEqualityFilterfilters numeric values that equal or do not equal a given numeric value.- Parameters:
numericEqualityFilter- ANumericEqualityFilterfilters 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.
-
numericEqualityFilter
default Filter.Builder numericEqualityFilter(Consumer<NumericEqualityFilter.Builder> numericEqualityFilter)
A
This is a convenience method that creates an instance of theNumericEqualityFilterfilters numeric values that equal or do not equal a given numeric value.NumericEqualityFilter.Builderavoiding the need to create one manually viaNumericEqualityFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tonumericEqualityFilter(NumericEqualityFilter).- Parameters:
numericEqualityFilter- a consumer that will call methods onNumericEqualityFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
numericEqualityFilter(NumericEqualityFilter)
-
timeEqualityFilter
Filter.Builder timeEqualityFilter(TimeEqualityFilter timeEqualityFilter)
A
TimeEqualityFilterfilters date-time values that equal or do not equal a given date/time value.- Parameters:
timeEqualityFilter- ATimeEqualityFilterfilters 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.
-
timeEqualityFilter
default Filter.Builder timeEqualityFilter(Consumer<TimeEqualityFilter.Builder> timeEqualityFilter)
A
This is a convenience method that creates an instance of theTimeEqualityFilterfilters date-time values that equal or do not equal a given date/time value.TimeEqualityFilter.Builderavoiding the need to create one manually viaTimeEqualityFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totimeEqualityFilter(TimeEqualityFilter).- Parameters:
timeEqualityFilter- a consumer that will call methods onTimeEqualityFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
timeEqualityFilter(TimeEqualityFilter)
-
timeRangeFilter
Filter.Builder timeRangeFilter(TimeRangeFilter timeRangeFilter)
A
TimeRangeFilterfilters date-time values that are either inside or outside a given date/time range.- Parameters:
timeRangeFilter- ATimeRangeFilterfilters 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.
-
timeRangeFilter
default Filter.Builder timeRangeFilter(Consumer<TimeRangeFilter.Builder> timeRangeFilter)
A
This is a convenience method that creates an instance of theTimeRangeFilterfilters date-time values that are either inside or outside a given date/time range.TimeRangeFilter.Builderavoiding the need to create one manually viaTimeRangeFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totimeRangeFilter(TimeRangeFilter).- Parameters:
timeRangeFilter- a consumer that will call methods onTimeRangeFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
timeRangeFilter(TimeRangeFilter)
-
relativeDatesFilter
Filter.Builder relativeDatesFilter(RelativeDatesFilter relativeDatesFilter)
A
RelativeDatesFilterfilters date values that are relative to a given date.- Parameters:
relativeDatesFilter- ARelativeDatesFilterfilters date values that are relative to a given date.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
relativeDatesFilter
default Filter.Builder relativeDatesFilter(Consumer<RelativeDatesFilter.Builder> relativeDatesFilter)
A
This is a convenience method that creates an instance of theRelativeDatesFilterfilters date values that are relative to a given date.RelativeDatesFilter.Builderavoiding the need to create one manually viaRelativeDatesFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torelativeDatesFilter(RelativeDatesFilter).- Parameters:
relativeDatesFilter- a consumer that will call methods onRelativeDatesFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
relativeDatesFilter(RelativeDatesFilter)
-
topBottomFilter
Filter.Builder topBottomFilter(TopBottomFilter topBottomFilter)
A
TopBottomFilterfilters data to the top or bottom values for a given column.- Parameters:
topBottomFilter- ATopBottomFilterfilters 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.
-
topBottomFilter
default Filter.Builder topBottomFilter(Consumer<TopBottomFilter.Builder> topBottomFilter)
A
This is a convenience method that creates an instance of theTopBottomFilterfilters data to the top or bottom values for a given column.TopBottomFilter.Builderavoiding the need to create one manually viaTopBottomFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totopBottomFilter(TopBottomFilter).- Parameters:
topBottomFilter- a consumer that will call methods onTopBottomFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
topBottomFilter(TopBottomFilter)
-
nestedFilter
Filter.Builder nestedFilter(NestedFilter nestedFilter)
A
NestedFilterfilters data with a subset of data that is defined by the nested inner filter.- Parameters:
nestedFilter- ANestedFilterfilters 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.
-
nestedFilter
default Filter.Builder nestedFilter(Consumer<NestedFilter.Builder> nestedFilter)
A
This is a convenience method that creates an instance of theNestedFilterfilters data with a subset of data that is defined by the nested inner filter.NestedFilter.Builderavoiding the need to create one manually viaNestedFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tonestedFilter(NestedFilter).- Parameters:
nestedFilter- a consumer that will call methods onNestedFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
nestedFilter(NestedFilter)
-
-