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

Class SheetVisualScopingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SheetVisualScopingConfiguration

All Implemented Interfaces:

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

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

The filter that is applied to the options.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SheetVisualScopingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SheetVisualScopingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVisualIds()	For responses, this returns true if the service returned a value for the VisualIds property.
FilterVisualScope	scope()	The scope of the applied entities.
String	scopeAsString()	The scope of the applied entities.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SheetVisualScopingConfiguration.Builder>	serializableBuilderClass()
String	sheetId()	The selected sheet that the filter is applied to.
SheetVisualScopingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	visualIds()	The selected visuals that the filter is applied to.

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

sheetId

public final String sheetId()

The selected sheet that the filter is applied to.

Returns:

The selected sheet that the filter is applied to.

scope

public final FilterVisualScope scope()

The scope of the applied entities. Choose one of the following options:

• ALL_VISUALS

• SELECTED_VISUALS

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

Returns:

The scope of the applied entities. Choose one of the following options:

• ALL_VISUALS

• SELECTED_VISUALS

See Also:

FilterVisualScope

scopeAsString

public final String scopeAsString()

The scope of the applied entities. Choose one of the following options:

• ALL_VISUALS

• SELECTED_VISUALS

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

Returns:

The scope of the applied entities. Choose one of the following options:

• ALL_VISUALS

• SELECTED_VISUALS

See Also:

FilterVisualScope

hasVisualIds

public final boolean hasVisualIds()

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

visualIds

public final List<String> visualIds()

The selected 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 hasVisualIds() method.

Returns:

The selected visuals that the filter is applied to.

toBuilder

public SheetVisualScopingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SheetVisualScopingConfiguration.Builder,SheetVisualScopingConfiguration>

builder

public static SheetVisualScopingConfiguration.Builder builder()

serializableBuilderClass

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