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

Class LegendOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.LegendOptions

All Implemented Interfaces:

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

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

The options for the legend setup of a visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LegendOptions.Builder

Method Summary

Modifier and Type	Method	Description
static LegendOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	height()	The height of the legend.
LegendPosition	position()	The positions for the legend.
String	positionAsString()	The positions for the legend.
List<SdkField<?>>	sdkFields()
static Class<? extends LegendOptions.Builder>	serializableBuilderClass()
LabelOptions	title()	The custom title for the legend.
LegendOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Visibility	visibility()	Determines whether or not the legend is visible.
String	visibilityAsString()	Determines whether or not the legend is visible.
String	width()	The width of the legend.

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

visibility

public final Visibility visibility()

Determines whether or not the legend is visible.

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

Returns:

Determines whether or not the legend is visible.

See Also:

Visibility

visibilityAsString

public final String visibilityAsString()

Determines whether or not the legend is visible.

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

Returns:

Determines whether or not the legend is visible.

See Also:

Visibility

title

public final LabelOptions title()

The custom title for the legend.

Returns:

The custom title for the legend.

position

public final LegendPosition position()

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

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

Returns:

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

See Also:

LegendPosition

positionAsString

public final String positionAsString()

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

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

Returns:

The positions for the legend. Choose one of the following options:

• AUTO

• RIGHT

• BOTTOM

• LEFT

See Also:

LegendPosition

width

public final String width()

The width of the legend. If this value is omitted, a default width is used when rendering.

Returns:

The width of the legend. If this value is omitted, a default width is used when rendering.

height

public final String height()

The height of the legend. If this value is omitted, a default height is used when rendering.

Returns:

The height of the legend. If this value is omitted, a default height is used when rendering.

toBuilder

public LegendOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LegendOptions.Builder,LegendOptions>

builder

public static LegendOptions.Builder builder()

serializableBuilderClass

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