Class DataLabelOptions

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

The options that determine the presentation of the data labels.

See Also:

  • Method Details

    • visibility

      public final Visibility visibility()

      Determines the visibility of the data labels.

      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 the visibility of the data labels.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      Determines the visibility of the data labels.

      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 the visibility of the data labels.
      See Also:

    • categoryLabelVisibility

      public final Visibility categoryLabelVisibility()

      Determines the visibility of the category field labels.

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

      Returns:
      Determines the visibility of the category field labels.
      See Also:

    • categoryLabelVisibilityAsString

      public final String categoryLabelVisibilityAsString()

      Determines the visibility of the category field labels.

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

      Returns:
      Determines the visibility of the category field labels.
      See Also:

    • measureLabelVisibility

      public final Visibility measureLabelVisibility()

      Determines the visibility of the measure field labels.

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

      Returns:
      Determines the visibility of the measure field labels.
      See Also:

    • measureLabelVisibilityAsString

      public final String measureLabelVisibilityAsString()

      Determines the visibility of the measure field labels.

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

      Returns:
      Determines the visibility of the measure field labels.
      See Also:

    • hasDataLabelTypes

      public final boolean hasDataLabelTypes()
      For responses, this returns true if the service returned a value for the DataLabelTypes 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.

    • dataLabelTypes

      public final List<DataLabelType> dataLabelTypes()

      The option that determines the data label type.

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

      Returns:
      The option that determines the data label type.

    • position

      public final DataLabelPosition position()

      Determines the position of the data labels.

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

      Returns:
      Determines the position of the data labels.
      See Also:

    • positionAsString

      public final String positionAsString()

      Determines the position of the data labels.

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

      Returns:
      Determines the position of the data labels.
      See Also:

    • labelContent

      public final DataLabelContent labelContent()

      Determines the content of the data labels.

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

      Returns:
      Determines the content of the data labels.
      See Also:

    • labelContentAsString

      public final String labelContentAsString()

      Determines the content of the data labels.

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

      Returns:
      Determines the content of the data labels.
      See Also:

    • labelFontConfiguration

      public final FontConfiguration labelFontConfiguration()

      Determines the font configuration of the data labels.

      Returns:
      Determines the font configuration of the data labels.

    • labelColor

      public final String labelColor()

      Determines the color of the data labels.

      Returns:
      Determines the color of the data labels.

    • overlap

      public final DataLabelOverlap overlap()

      Determines whether overlap is enabled or disabled for the data labels.

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

      Returns:
      Determines whether overlap is enabled or disabled for the data labels.
      See Also:

    • overlapAsString

      public final String overlapAsString()

      Determines whether overlap is enabled or disabled for the data labels.

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

      Returns:
      Determines whether overlap is enabled or disabled for the data labels.
      See Also:

    • totalsVisibility

      public final Visibility totalsVisibility()

      Determines the visibility of the total.

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

      Returns:
      Determines the visibility of the total.
      See Also:

    • totalsVisibilityAsString

      public final String totalsVisibilityAsString()

      Determines the visibility of the total.

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

      Returns:
      Determines the visibility of the total.
      See Also:

    • toBuilder

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

    • builder

      public static DataLabelOptions.Builder builder()

    • serializableBuilderClass

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