software.amazon.awssdk.services.quicksight.model

Class ColorScale

java.lang.Object

software.amazon.awssdk.services.quicksight.model.ColorScale

All Implemented Interfaces:

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

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

Determines the color scale that is applied to the visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColorScale.Builder

Method Summary

Modifier and Type	Method and Description
static ColorScale.Builder	builder()
ColorFillType	colorFillType() Determines the color fill type.
String	colorFillTypeAsString() Determines the color fill type.
List<DataColor>	colors() Determines the list of colors that are applied to the visual.
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()
DataColor	nullValueColor() Determines the color that is applied to null values.
List<SdkField<?>>	sdkFields()
static Class<? extends ColorScale.Builder>	serializableBuilderClass()
ColorScale.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<DataColor> colors()

Determines the list of colors that are applied to the visual.

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:

Determines the list of colors that are applied to the visual.

colorFillType

public final ColorFillType colorFillType()

Determines the color fill type.

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

Returns:

Determines the color fill type.

See Also:

ColorFillType

colorFillTypeAsString

public final String colorFillTypeAsString()

Determines the color fill type.

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

Returns:

Determines the color fill type.

See Also:

ColorFillType

nullValueColor

public final DataColor nullValueColor()

Determines the color that is applied to null values.

Returns:

Determines the color that is applied to null values.

toBuilder

public ColorScale.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ColorScale.Builder,ColorScale>

builder

public static ColorScale.Builder builder()

serializableBuilderClass

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