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

Class DataColorPalette

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DataColorPalette

All Implemented Interfaces:

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

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

The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataColorPalette.Builder

Method Summary

Modifier and Type	Method	Description
static DataColorPalette.Builder	builder()
List<String>	colors()	The hexadecimal codes for the colors.
String	emptyFillColor()	The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColors()	For responses, this returns true if the service returned a value for the Colors property.
int	hashCode()
boolean	hasMinMaxGradient()	For responses, this returns true if the service returned a value for the MinMaxGradient property.
List<String>	minMaxGradient()	The minimum and maximum hexadecimal codes that describe a color gradient.
List<SdkField<?>>	sdkFields()
static Class<? extends DataColorPalette.Builder>	serializableBuilderClass()
DataColorPalette.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

hasColors

public final boolean hasColors()

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

colors

public final List<String> colors()

The hexadecimal codes for the colors.

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

Returns:

The hexadecimal codes for the colors.

hasMinMaxGradient

public final boolean hasMinMaxGradient()

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

minMaxGradient

public final List<String> minMaxGradient()

The minimum and maximum hexadecimal codes that describe a color gradient.

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

Returns:

The minimum and maximum hexadecimal codes that describe a color gradient.

emptyFillColor

public final String emptyFillColor()

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

Returns:

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

toBuilder

public DataColorPalette.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataColorPalette.Builder,DataColorPalette>

builder

public static DataColorPalette.Builder builder()

serializableBuilderClass

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