Package software.amazon.awssdk.services.quicksight.model

Class FilterControl

java.lang.Object

software.amazon.awssdk.services.quicksight.model.FilterControl

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FilterControl.Builder,FilterControl>

@Generated("software.amazon.awssdk:codegen")
public final class FilterControl
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FilterControl.Builder,FilterControl>

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterControl.Builder

Method Summary

Modifier and Type	Method	Description
static FilterControl.Builder	builder()
FilterCrossSheetControl	crossSheet()	A control from a filter that is scoped across more than one sheet.
FilterDateTimePickerControl	dateTimePicker()	A control from a date filter that is used to specify date and time.
FilterDropDownControl	dropdown()	A control to display a dropdown list with buttons that are used to select a single value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
FilterListControl	list()	A control to display a list of buttons or boxes.
FilterRelativeDateTimeControl	relativeDateTime()	A control from a date filter that is used to specify the relative date.
List<SdkField<?>>	sdkFields()
static Class<? extends FilterControl.Builder>	serializableBuilderClass()
FilterSliderControl	slider()	A control to display a horizontal toggle bar.
FilterTextAreaControl	textArea()	A control to display a text box that is used to enter multiple entries.
FilterTextFieldControl	textField()	A control to display a text box that is used to enter a single entry.
FilterControl.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

dateTimePicker

public final FilterDateTimePickerControl dateTimePicker()

A control from a date filter that is used to specify date and time.

Returns:

A control from a date filter that is used to specify date and time.

list

public final FilterListControl list()

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

Returns:

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

dropdown

public final FilterDropDownControl dropdown()

A control to display a dropdown list with buttons that are used to select a single value.

Returns:

A control to display a dropdown list with buttons that are used to select a single value.

textField

public final FilterTextFieldControl textField()

A control to display a text box that is used to enter a single entry.

Returns:

A control to display a text box that is used to enter a single entry.

textArea

public final FilterTextAreaControl textArea()

A control to display a text box that is used to enter multiple entries.

Returns:

A control to display a text box that is used to enter multiple entries.

slider

public final FilterSliderControl slider()

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

Returns:

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

relativeDateTime

public final FilterRelativeDateTimeControl relativeDateTime()

A control from a date filter that is used to specify the relative date.

Returns:

A control from a date filter that is used to specify the relative date.

crossSheet

public final FilterCrossSheetControl crossSheet()

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

Returns:

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

toBuilder

public FilterControl.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterControl.Builder,FilterControl>

builder

public static FilterControl.Builder builder()

serializableBuilderClass

public static Class<? extends FilterControl.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo