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

Class VisualPalette

java.lang.Object

software.amazon.awssdk.services.quicksight.model.VisualPalette

All Implemented Interfaces:

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

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

The visual display options for the visual palette.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VisualPalette.Builder

Method Summary

Modifier and Type	Method	Description
static VisualPalette.Builder	builder()
String	chartColor()	The chart color options for the visual palette.
List<DataPathColor>	colorMap()	The color map options for the visual palette.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColorMap()	For responses, this returns true if the service returned a value for the ColorMap property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VisualPalette.Builder>	serializableBuilderClass()
VisualPalette.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

chartColor

public final String chartColor()

The chart color options for the visual palette.

Returns:

The chart color options for the visual palette.

hasColorMap

public final boolean hasColorMap()

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

colorMap

public final List<DataPathColor> colorMap()

The color map options for the visual palette.

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

Returns:

The color map options for the visual palette.

toBuilder

public VisualPalette.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VisualPalette.Builder,VisualPalette>

builder

public static VisualPalette.Builder builder()

serializableBuilderClass

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