software.amazon.awssdk.services.quicksight.model

Class SameSheetTargetVisualConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SameSheetTargetVisualConfiguration

All Implemented Interfaces:

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

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

The configuration of the same-sheet target visuals that you want to be filtered.

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

Method Summary

Modifier and Type	Method and Description
static SameSheetTargetVisualConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargetVisuals() For responses, this returns true if the service returned a value for the TargetVisuals property.
List<SdkField<?>>	sdkFields()
static Class<? extends SameSheetTargetVisualConfiguration.Builder>	serializableBuilderClass()
TargetVisualOptions	targetVisualOptions() The options that choose the target visual in the same sheet.
String	targetVisualOptionsAsString() The options that choose the target visual in the same sheet.
List<String>	targetVisuals() A list of the target visual IDs that are located in the same sheet of the analysis.
SameSheetTargetVisualConfiguration.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

hasTargetVisuals

public final boolean hasTargetVisuals()

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

targetVisuals

public final List<String> targetVisuals()

A list of the target visual IDs that are located in the same sheet of the analysis.

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

Returns:

A list of the target visual IDs that are located in the same sheet of the analysis.

targetVisualOptions

public final TargetVisualOptions targetVisualOptions()

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

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

Returns:

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

See Also:

TargetVisualOptions

targetVisualOptionsAsString

public final String targetVisualOptionsAsString()

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

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

Returns:

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

See Also:

TargetVisualOptions

toBuilder

public SameSheetTargetVisualConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SameSheetTargetVisualConfiguration.Builder,SameSheetTargetVisualConfiguration>

builder

public static SameSheetTargetVisualConfiguration.Builder builder()

serializableBuilderClass

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