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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PivotTotalOptions.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PivotTotalOptions.Builder`	`builder()`
`String`	`customLabel()`	The custom label string for the total cells.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTotalAggregationOptions()`	For responses, this returns true if the service returned a value for the TotalAggregationOptions property.
`TableCellStyle`	`metricHeaderCellStyle()`	The cell styling options for the total of header cells.
`TableTotalsPlacement`	`placement()`	The placement (start, end) for the total cells.
`String`	`placementAsString()`	The placement (start, end) for the total cells.
`TableTotalsScrollStatus`	`scrollStatus()`	The scroll status (pinned, scrolled) for the total cells.
`String`	`scrollStatusAsString()`	The scroll status (pinned, scrolled) for the total cells.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PivotTotalOptions.Builder>`	`serializableBuilderClass()`
`PivotTotalOptions.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<TotalAggregationOption>`	`totalAggregationOptions()`	The total aggregation options for each value field.
`TableCellStyle`	`totalCellStyle()`	The cell styling options for the total cells.
`Visibility`	`totalsVisibility()`	The visibility configuration for the total cells.
`String`	`totalsVisibilityAsString()`	The visibility configuration for the total cells.
`TableCellStyle`	`valueCellStyle()`	The cell styling options for the totals of value cells.

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
  - 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:
    
    Visibility
  - 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:
    
    Visibility
  - 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:
    
    TableTotalsPlacement
  - 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:
    
    TableTotalsPlacement
  - 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:
    
    TableTotalsScrollStatus
  - 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:
    
    TableTotalsScrollStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PivotTotalOptions.Builder,PivotTotalOptions>
  - 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)
```
    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

Class PivotTotalOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

totalsVisibility

totalsVisibilityAsString

placement

placementAsString

scrollStatus

scrollStatusAsString

customLabel

totalCellStyle

valueCellStyle

metricHeaderCellStyle

hasTotalAggregationOptions

totalAggregationOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields