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

Class FilterScopeConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.FilterScopeConfiguration

All Implemented Interfaces:

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

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

The scope configuration for a FilterGroup.

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	FilterScopeConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
AllSheetsFilterScopeConfiguration	allSheets()	The configuration that applies a filter to all sheets.
static FilterScopeConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SelectedSheetsFilterScopeConfiguration	selectedSheets()	The configuration for applying a filter to specific sheets.
static Class<? extends FilterScopeConfiguration.Builder>	serializableBuilderClass()
FilterScopeConfiguration.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

selectedSheets

public final SelectedSheetsFilterScopeConfiguration selectedSheets()

The configuration for applying a filter to specific sheets.

Returns:

The configuration for applying a filter to specific sheets.

allSheets

public final AllSheetsFilterScopeConfiguration allSheets()

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

Returns:

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

toBuilder

public FilterScopeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterScopeConfiguration.Builder,FilterScopeConfiguration>

builder

public static FilterScopeConfiguration.Builder builder()

serializableBuilderClass

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