software.amazon.awssdk.services.quicksight.model

Class FilterGroup

java.lang.Object

software.amazon.awssdk.services.quicksight.model.FilterGroup

All Implemented Interfaces:

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

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

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FilterGroup.Builder

Method Summary

Modifier and Type	Method and Description
static FilterGroup.Builder	builder()
CrossDatasetTypes	crossDataset() The filter new feature which can apply filter group to all data sets.
String	crossDatasetAsString() The filter new feature which can apply filter group to all data sets.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterGroupId() The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.
List<Filter>	filters() The list of filters that are present in a FilterGroup.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
FilterScopeConfiguration	scopeConfiguration() The configuration that specifies what scope to apply to a FilterGroup.
List<SdkField<?>>	sdkFields()
static Class<? extends FilterGroup.Builder>	serializableBuilderClass()
WidgetStatus	status() The status of the FilterGroup.
String	statusAsString() The status of the FilterGroup.
FilterGroup.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

filterGroupId

public final String filterGroupId()

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

Returns:

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<Filter> filters()

The list of filters that are present in a FilterGroup.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

The list of filters that are present in a FilterGroup.

scopeConfiguration

public final FilterScopeConfiguration scopeConfiguration()

The configuration that specifies what scope to apply to a FilterGroup.

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

Returns:

The configuration that specifies what scope to apply to a FilterGroup.

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

status

public final WidgetStatus status()

The status of the FilterGroup.

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

Returns:

The status of the FilterGroup.

See Also:

WidgetStatus

statusAsString

public final String statusAsString()

The status of the FilterGroup.

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

Returns:

The status of the FilterGroup.

See Also:

WidgetStatus

crossDataset

public final CrossDatasetTypes crossDataset()

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

• ALL_DATASETS

• SINGLE_DATASET

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

Returns:

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

• ALL_DATASETS

• SINGLE_DATASET

See Also:

CrossDatasetTypes

crossDatasetAsString

public final String crossDatasetAsString()

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

• ALL_DATASETS

• SINGLE_DATASET

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

Returns:

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

• ALL_DATASETS

• SINGLE_DATASET

See Also:

CrossDatasetTypes

toBuilder

public FilterGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterGroup.Builder,FilterGroup>

builder

public static FilterGroup.Builder builder()

serializableBuilderClass

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