software.amazon.awssdk.services.quicksight.model

Class SelectedSheetsFilterScopeConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SelectedSheetsFilterScopeConfiguration

All Implemented Interfaces:

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

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

The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.

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 and Description
static interface	SelectedSheetsFilterScopeConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SelectedSheetsFilterScopeConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSheetVisualScopingConfigurations() For responses, this returns true if the service returned a value for the SheetVisualScopingConfigurations property.
List<SdkField<?>>	sdkFields()
static Class<? extends SelectedSheetsFilterScopeConfiguration.Builder>	serializableBuilderClass()
List<SheetVisualScopingConfiguration>	sheetVisualScopingConfigurations() The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.
SelectedSheetsFilterScopeConfiguration.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

hasSheetVisualScopingConfigurations

public final boolean hasSheetVisualScopingConfigurations()

For responses, this returns true if the service returned a value for the SheetVisualScopingConfigurations 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.

sheetVisualScopingConfigurations

public final List<SheetVisualScopingConfiguration> sheetVisualScopingConfigurations()

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

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 hasSheetVisualScopingConfigurations() method.

Returns:

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

toBuilder

public SelectedSheetsFilterScopeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SelectedSheetsFilterScopeConfiguration.Builder,SelectedSheetsFilterScopeConfiguration>

builder

public static SelectedSheetsFilterScopeConfiguration.Builder builder()

serializableBuilderClass

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