Class DecalSettings

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DecalSettings

All Implemented Interfaces:

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

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

Decal settings for accessibility features that define visual patterns and styling for data elements.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DecalSettings.Builder

Method Summary

Modifier and Type	Method	Description
static DecalSettings.Builder	builder()
final String	decalColor()	Color configuration for the decal pattern.
final DecalPatternType	decalPatternType()	Type of pattern used for the decal, such as solid, diagonal, or circular patterns in various sizes.
final String	decalPatternTypeAsString()	Type of pattern used for the decal, such as solid, diagonal, or circular patterns in various sizes.
final DecalStyleType	decalStyleType()	Style type for the decal, which can be either manual or automatic.
final String	decalStyleTypeAsString()	Style type for the decal, which can be either manual or automatic.
final Visibility	decalVisibility()	Visibility setting for the decal pattern.
final String	decalVisibilityAsString()	Visibility setting for the decal pattern.
final String	elementValue()	Field value of the field that you are setting the decal pattern to.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DecalSettings.Builder>	serializableBuilderClass()
DecalSettings.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

elementValue

public final String elementValue()

Field value of the field that you are setting the decal pattern to. Applicable only for field level settings.

Returns:

Field value of the field that you are setting the decal pattern to. Applicable only for field level settings.

decalVisibility

public final Visibility decalVisibility()

Visibility setting for the decal pattern.

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

Returns:

Visibility setting for the decal pattern.

See Also:

• Visibility

decalVisibilityAsString

public final String decalVisibilityAsString()

Visibility setting for the decal pattern.

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

Returns:

Visibility setting for the decal pattern.

See Also:

• Visibility

decalColor

public final String decalColor()

Color configuration for the decal pattern.

Returns:

Color configuration for the decal pattern.

decalPatternType

public final DecalPatternType decalPatternType()

Type of pattern used for the decal, such as solid, diagonal, or circular patterns in various sizes.

• SOLID: Solid fill pattern.

• DIAGONAL_SMALL: Small diagonal stripes pattern.

• DIAGONAL_MEDIUM: Medium diagonal stripes pattern.

• DIAGONAL_LARGE: Large diagonal stripes pattern.

• DIAGONAL_OPPOSITE_SMALL: Small cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_MEDIUM: Medium cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_LARGE: Large cross-diagonal stripes pattern.

• CIRCLE_SMALL: Small circle pattern.

• CIRCLE_MEDIUM: Medium circle pattern.

• CIRCLE_LARGE: Large circle pattern.

• DIAMOND_SMALL: Small diamonds pattern.

• DIAMOND_MEDIUM: Medium diamonds pattern.

• DIAMOND_LARGE: Large diamonds pattern.

• DIAMOND_GRID_SMALL: Small diamond grid pattern.

• DIAMOND_GRID_MEDIUM: Medium diamond grid pattern.

• DIAMOND_GRID_LARGE: Large diamond grid pattern.

• CHECKERBOARD_SMALL: Small checkerboard pattern.

• CHECKERBOARD_MEDIUM: Medium checkerboard pattern.

• CHECKERBOARD_LARGE: Large checkerboard pattern.

• TRIANGLE_SMALL: Small triangles pattern.

• TRIANGLE_MEDIUM: Medium triangles pattern.

• TRIANGLE_LARGE: Large triangles pattern.

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

Returns:

Type of pattern used for the decal, such as solid, diagonal, or circular patterns in various sizes.

• SOLID: Solid fill pattern.

• DIAGONAL_SMALL: Small diagonal stripes pattern.

• DIAGONAL_MEDIUM: Medium diagonal stripes pattern.

• DIAGONAL_LARGE: Large diagonal stripes pattern.

• DIAGONAL_OPPOSITE_SMALL: Small cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_MEDIUM: Medium cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_LARGE: Large cross-diagonal stripes pattern.

• CIRCLE_SMALL: Small circle pattern.

• CIRCLE_MEDIUM: Medium circle pattern.

• CIRCLE_LARGE: Large circle pattern.

• DIAMOND_SMALL: Small diamonds pattern.

• DIAMOND_MEDIUM: Medium diamonds pattern.

• DIAMOND_LARGE: Large diamonds pattern.

• DIAMOND_GRID_SMALL: Small diamond grid pattern.

• DIAMOND_GRID_MEDIUM: Medium diamond grid pattern.

• DIAMOND_GRID_LARGE: Large diamond grid pattern.

• CHECKERBOARD_SMALL: Small checkerboard pattern.

• CHECKERBOARD_MEDIUM: Medium checkerboard pattern.

• CHECKERBOARD_LARGE: Large checkerboard pattern.

• TRIANGLE_SMALL: Small triangles pattern.

• TRIANGLE_MEDIUM: Medium triangles pattern.

• TRIANGLE_LARGE: Large triangles pattern.

See Also:

• DecalPatternType

decalPatternTypeAsString

public final String decalPatternTypeAsString()

Type of pattern used for the decal, such as solid, diagonal, or circular patterns in various sizes.

• SOLID: Solid fill pattern.

• DIAGONAL_SMALL: Small diagonal stripes pattern.

• DIAGONAL_MEDIUM: Medium diagonal stripes pattern.

• DIAGONAL_LARGE: Large diagonal stripes pattern.

• DIAGONAL_OPPOSITE_SMALL: Small cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_MEDIUM: Medium cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_LARGE: Large cross-diagonal stripes pattern.

• CIRCLE_SMALL: Small circle pattern.

• CIRCLE_MEDIUM: Medium circle pattern.

• CIRCLE_LARGE: Large circle pattern.

• DIAMOND_SMALL: Small diamonds pattern.

• DIAMOND_MEDIUM: Medium diamonds pattern.

• DIAMOND_LARGE: Large diamonds pattern.

• DIAMOND_GRID_SMALL: Small diamond grid pattern.

• DIAMOND_GRID_MEDIUM: Medium diamond grid pattern.

• DIAMOND_GRID_LARGE: Large diamond grid pattern.

• CHECKERBOARD_SMALL: Small checkerboard pattern.

• CHECKERBOARD_MEDIUM: Medium checkerboard pattern.

• CHECKERBOARD_LARGE: Large checkerboard pattern.

• TRIANGLE_SMALL: Small triangles pattern.

• TRIANGLE_MEDIUM: Medium triangles pattern.

• TRIANGLE_LARGE: Large triangles pattern.

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

Returns:

Type of pattern used for the decal, such as solid, diagonal, or circular patterns in various sizes.

• SOLID: Solid fill pattern.

• DIAGONAL_SMALL: Small diagonal stripes pattern.

• DIAGONAL_MEDIUM: Medium diagonal stripes pattern.

• DIAGONAL_LARGE: Large diagonal stripes pattern.

• DIAGONAL_OPPOSITE_SMALL: Small cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_MEDIUM: Medium cross-diagonal stripes pattern.

• DIAGONAL_OPPOSITE_LARGE: Large cross-diagonal stripes pattern.

• CIRCLE_SMALL: Small circle pattern.

• CIRCLE_MEDIUM: Medium circle pattern.

• CIRCLE_LARGE: Large circle pattern.

• DIAMOND_SMALL: Small diamonds pattern.

• DIAMOND_MEDIUM: Medium diamonds pattern.

• DIAMOND_LARGE: Large diamonds pattern.

• DIAMOND_GRID_SMALL: Small diamond grid pattern.

• DIAMOND_GRID_MEDIUM: Medium diamond grid pattern.

• DIAMOND_GRID_LARGE: Large diamond grid pattern.

• CHECKERBOARD_SMALL: Small checkerboard pattern.

• CHECKERBOARD_MEDIUM: Medium checkerboard pattern.

• CHECKERBOARD_LARGE: Large checkerboard pattern.

• TRIANGLE_SMALL: Small triangles pattern.

• TRIANGLE_MEDIUM: Medium triangles pattern.

• TRIANGLE_LARGE: Large triangles pattern.

See Also:

• DecalPatternType

decalStyleType

public final DecalStyleType decalStyleType()

Style type for the decal, which can be either manual or automatic. This field is only applicable for line series.

• Manual: Apply manual line and marker configuration for line series.

• Auto: Apply automatic line and marker configuration for line series.

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

Returns:

Style type for the decal, which can be either manual or automatic. This field is only applicable for line series.

• Manual: Apply manual line and marker configuration for line series.

• Auto: Apply automatic line and marker configuration for line series.

See Also:

• DecalStyleType

decalStyleTypeAsString

public final String decalStyleTypeAsString()

Style type for the decal, which can be either manual or automatic. This field is only applicable for line series.

• Manual: Apply manual line and marker configuration for line series.

• Auto: Apply automatic line and marker configuration for line series.

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

Returns:

Style type for the decal, which can be either manual or automatic. This field is only applicable for line series.

• Manual: Apply manual line and marker configuration for line series.

• Auto: Apply automatic line and marker configuration for line series.

See Also:

• DecalStyleType

toBuilder

public DecalSettings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DecalSettings.Builder,DecalSettings>

Returns:

a builder for type T

builder

public static DecalSettings.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.