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

Class ChartAxisLabelOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.ChartAxisLabelOptions

All Implemented Interfaces:

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

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

The label options for an axis on a chart.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChartAxisLabelOptions.Builder

Method Summary

Modifier and Type	Method	Description
List<AxisLabelOptions>	axisLabelOptions()	The label options for a chart axis.
static ChartAxisLabelOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAxisLabelOptions()	For responses, this returns true if the service returned a value for the AxisLabelOptions property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ChartAxisLabelOptions.Builder>	serializableBuilderClass()
Visibility	sortIconVisibility()	The visibility configuration of the sort icon on a chart's axis label.
String	sortIconVisibilityAsString()	The visibility configuration of the sort icon on a chart's axis label.
ChartAxisLabelOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Visibility	visibility()	The visibility of an axis label on a chart.
String	visibilityAsString()	The visibility of an axis label on a chart.

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()

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE: Shows the axis.

• HIDDEN: Hides the axis.

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:

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE: Shows the axis.

• HIDDEN: Hides the axis.

See Also:

Visibility

visibilityAsString

public final String visibilityAsString()

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE: Shows the axis.

• HIDDEN: Hides the axis.

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:

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE: Shows the axis.

• HIDDEN: Hides the axis.

See Also:

Visibility

sortIconVisibility

public final Visibility sortIconVisibility()

The visibility configuration of the sort icon on a chart's axis label.

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

Returns:

The visibility configuration of the sort icon on a chart's axis label.

See Also:

Visibility

sortIconVisibilityAsString

public final String sortIconVisibilityAsString()

The visibility configuration of the sort icon on a chart's axis label.

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

Returns:

The visibility configuration of the sort icon on a chart's axis label.

See Also:

Visibility

hasAxisLabelOptions

public final boolean hasAxisLabelOptions()

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

axisLabelOptions

public final List<AxisLabelOptions> axisLabelOptions()

The label options for a chart axis.

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

Returns:

The label options for a chart axis.

toBuilder

public ChartAxisLabelOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChartAxisLabelOptions.Builder,ChartAxisLabelOptions>

builder

public static ChartAxisLabelOptions.Builder builder()

serializableBuilderClass

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