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

Class FilterDropDownControl

java.lang.Object

software.amazon.awssdk.services.quicksight.model.FilterDropDownControl

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterDropDownControl.Builder

Method Summary

Modifier and Type	Method	Description
static FilterDropDownControl.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.
CommitMode	commitMode()	The visibility configuration of the Apply button on a FilterDropDownControl.
String	commitModeAsString()	The visibility configuration of the Apply button on a FilterDropDownControl.
DropDownControlDisplayOptions	displayOptions()	The display options of the FilterDropDownControl.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterControlId()	The ID of the FilterDropDownControl.
<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 FilterDropDownControl.Builder>	serializableBuilderClass()
String	sourceFilterId()	The source filter ID of the FilterDropDownControl.
String	title()	The title of the FilterDropDownControl.
FilterDropDownControl.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SheetControlListType	type()	The type of the FilterDropDownControl.
String	typeAsString()	The type of the FilterDropDownControl.

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 FilterDropDownControl.

Returns:

The ID of the FilterDropDownControl.

title

public final String title()

The title of the FilterDropDownControl.

Returns:

The title of the FilterDropDownControl.

sourceFilterId

public final String sourceFilterId()

The source filter ID of the FilterDropDownControl.

Returns:

The source filter ID of the FilterDropDownControl.

displayOptions

public final DropDownControlDisplayOptions displayOptions()

The display options of the FilterDropDownControl.

Returns:

The display options of the FilterDropDownControl.

type

public final SheetControlListType type()

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

• MULTI_SELECT: The user can select multiple entries from a dropdown menu.

• SINGLE_SELECT: The user can select a single entry from a dropdown menu.

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 FilterDropDownControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from a dropdown menu.

• SINGLE_SELECT: The user can select a single entry from a dropdown menu.

See Also:

SheetControlListType

typeAsString

public final String typeAsString()

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

• MULTI_SELECT: The user can select multiple entries from a dropdown menu.

• SINGLE_SELECT: The user can select a single entry from a dropdown menu.

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 FilterDropDownControl. Choose one of the following options:

• MULTI_SELECT: The user can select multiple entries from a dropdown menu.

• SINGLE_SELECT: The user can select a single entry from a dropdown menu.

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.

commitMode

public final CommitMode commitMode()

The visibility configuration of the Apply button on a FilterDropDownControl.

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

Returns:

The visibility configuration of the Apply button on a FilterDropDownControl.

See Also:

CommitMode

commitModeAsString

public final String commitModeAsString()

The visibility configuration of the Apply button on a FilterDropDownControl.

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

Returns:

The visibility configuration of the Apply button on a FilterDropDownControl.

See Also:

CommitMode

toBuilder

public FilterDropDownControl.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterDropDownControl.Builder,FilterDropDownControl>

builder

public static FilterDropDownControl.Builder builder()

serializableBuilderClass

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