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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<ChartAxisLabelOptions.Builder,ChartAxisLabelOptions>
      Returns:
      a builder for type T

    • 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)
      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.