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

Class FilterListControl

java.lang.Object

software.amazon.awssdk.services.quicksight.model.FilterListControl

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterListControl.Builder

Method Summary

Modifier and Type	Method	Description
static FilterListControl.Builder	builder()
CascadingControlConfiguration	cascadingControlConfiguration()	The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
ListControlDisplayOptions	displayOptions()	The display options of a control.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterControlId()	The ID of the FilterListControl.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
FilterSelectableValues	selectableValues()	A list of selectable values that are used in a control.
static Class<? extends FilterListControl.Builder>	serializableBuilderClass()
String	sourceFilterId()	The source filter ID of the FilterListControl.
String	title()	The title of the FilterListControl.
FilterListControl.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SheetControlListType	type()	The type of the FilterListControl.
String	typeAsString()	The type of the FilterListControl.

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

filterControlId

public final String filterControlId()

The ID of the FilterListControl.

Returns:

The ID of the FilterListControl.

title

public final String title()

The title of the FilterListControl.

Returns:

The title of the FilterListControl.

sourceFilterId

public final String sourceFilterId()

The source filter ID of the FilterListControl.

Returns:

The source filter ID of the FilterListControl.

displayOptions

public final ListControlDisplayOptions displayOptions()

The display options of a control.

Returns:

The display options of a control.

type

public final SheetControlListType type()

The type of the FilterListControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from the list.

• SINGLE_SELECT: The user can select a single entry from the list.

If the service returns an enum value that is not available in the current SDK version, type will return SheetControlListType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the FilterListControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from the list.

• SINGLE_SELECT: The user can select a single entry from the list.

See Also:

SheetControlListType

typeAsString

public final String typeAsString()

The type of the FilterListControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from the list.

• SINGLE_SELECT: The user can select a single entry from the list.

If the service returns an enum value that is not available in the current SDK version, type will return SheetControlListType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the FilterListControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from the list.

• SINGLE_SELECT: The user can select a single entry from the list.

See Also:

SheetControlListType

selectableValues

public final FilterSelectableValues selectableValues()

A list of selectable values that are used in a control.

Returns:

A list of selectable values that are used in a control.

cascadingControlConfiguration

public final CascadingControlConfiguration cascadingControlConfiguration()

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

Returns:

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

toBuilder

public FilterListControl.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterListControl.Builder,FilterListControl>

builder

public static FilterListControl.Builder builder()

serializableBuilderClass

public static Class<? extends FilterListControl.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo