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

Class GeospatialGradientColor

java.lang.Object

software.amazon.awssdk.services.quicksight.model.GeospatialGradientColor

All Implemented Interfaces:

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

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

The definition for a gradient color.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeospatialGradientColor.Builder

Method Summary

Modifier and Type	Method	Description
static GeospatialGradientColor.Builder	builder()
Double	defaultOpacity()	The default opacity for the gradient color.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStepColors()	For responses, this returns true if the service returned a value for the StepColors property.
GeospatialNullDataSettings	nullDataSettings()	The null data visualization settings.
Visibility	nullDataVisibility()	The state of visibility for null data.
String	nullDataVisibilityAsString()	The state of visibility for null data.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GeospatialGradientColor.Builder>	serializableBuilderClass()
List<GeospatialGradientStepColor>	stepColors()	A list of gradient step colors for the gradient.
GeospatialGradientColor.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

hasStepColors

public final boolean hasStepColors()

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

stepColors

public final List<GeospatialGradientStepColor> stepColors()

A list of gradient step colors for the 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 hasStepColors() method.

Returns:

A list of gradient step colors for the gradient.

nullDataVisibility

public final Visibility nullDataVisibility()

The state of visibility for null data.

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

Returns:

The state of visibility for null data.

See Also:

Visibility

nullDataVisibilityAsString

public final String nullDataVisibilityAsString()

The state of visibility for null data.

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

Returns:

The state of visibility for null data.

See Also:

Visibility

nullDataSettings

public final GeospatialNullDataSettings nullDataSettings()

The null data visualization settings.

Returns:

The null data visualization settings.

defaultOpacity

public final Double defaultOpacity()

The default opacity for the gradient color.

Returns:

The default opacity for the gradient color.

toBuilder

public GeospatialGradientColor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GeospatialGradientColor.Builder,GeospatialGradientColor>

builder

public static GeospatialGradientColor.Builder builder()

serializableBuilderClass

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