Class PivotTotalOptions

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

The optional configuration of totals cells in a PivotTableVisual.

See Also:

  • Method Details

    • totalsVisibility

      public final Visibility totalsVisibility()

      The visibility configuration for the total cells.

      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:
      The visibility configuration for the total cells.
      See Also:

    • totalsVisibilityAsString

      public final String totalsVisibilityAsString()

      The visibility configuration for the total cells.

      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:
      The visibility configuration for the total cells.
      See Also:

    • placement

      public final TableTotalsPlacement placement()

      The placement (start, end) for the total cells.

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

      Returns:
      The placement (start, end) for the total cells.
      See Also:

    • placementAsString

      public final String placementAsString()

      The placement (start, end) for the total cells.

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

      Returns:
      The placement (start, end) for the total cells.
      See Also:

    • scrollStatus

      public final TableTotalsScrollStatus scrollStatus()

      The scroll status (pinned, scrolled) for the total cells.

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

      Returns:
      The scroll status (pinned, scrolled) for the total cells.
      See Also:

    • scrollStatusAsString

      public final String scrollStatusAsString()

      The scroll status (pinned, scrolled) for the total cells.

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

      Returns:
      The scroll status (pinned, scrolled) for the total cells.
      See Also:

    • customLabel

      public final String customLabel()

      The custom label string for the total cells.

      Returns:
      The custom label string for the total cells.

    • totalCellStyle

      public final TableCellStyle totalCellStyle()

      The cell styling options for the total cells.

      Returns:
      The cell styling options for the total cells.

    • valueCellStyle

      public final TableCellStyle valueCellStyle()

      The cell styling options for the totals of value cells.

      Returns:
      The cell styling options for the totals of value cells.

    • metricHeaderCellStyle

      public final TableCellStyle metricHeaderCellStyle()

      The cell styling options for the total of header cells.

      Returns:
      The cell styling options for the total of header cells.

    • hasTotalAggregationOptions

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

    • totalAggregationOptions

      public final List<TotalAggregationOption> totalAggregationOptions()

      The total aggregation options for each value field.

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

      Returns:
      The total aggregation options for each value field.

    • toBuilder

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

    • builder

      public static PivotTotalOptions.Builder builder()

    • serializableBuilderClass

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