Class SmallMultiplesAxisProperties

java.lang.Object
software.amazon.awssdk.services.quicksight.model.SmallMultiplesAxisProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SmallMultiplesAxisProperties.Builder,SmallMultiplesAxisProperties>
@Generated("software.amazon.awssdk:codegen") public final class SmallMultiplesAxisProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SmallMultiplesAxisProperties.Builder,SmallMultiplesAxisProperties>

Configures the properties of a chart's axes that are used by small multiples panels.

See Also:

  • Method Details

    • scale

      public final SmallMultiplesAxisScale scale()

      Determines whether scale of the axes are shared or independent. The default value is SHARED.

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

      Returns:
      Determines whether scale of the axes are shared or independent. The default value is SHARED.
      See Also:

    • scaleAsString

      public final String scaleAsString()

      Determines whether scale of the axes are shared or independent. The default value is SHARED.

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

      Returns:
      Determines whether scale of the axes are shared or independent. The default value is SHARED.
      See Also:

    • placement

      public final SmallMultiplesAxisPlacement placement()

      Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

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

      Returns:
      Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
      See Also:

    • placementAsString

      public final String placementAsString()

      Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

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

      Returns:
      Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
      See Also:

    • toBuilder

      public SmallMultiplesAxisProperties.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<SmallMultiplesAxisProperties.Builder,SmallMultiplesAxisProperties>
      Returns:
      a builder for type T

    • builder

      public static SmallMultiplesAxisProperties.Builder builder()

    • serializableBuilderClass

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