SubtotalOptions (AWS Java SDK :: Services :: QuickSight 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.SubtotalOptions

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SubtotalOptions.Builder,SubtotalOptions>

@Generated(value="software.amazon.awssdk:codegen")
public final class SubtotalOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SubtotalOptions.Builder,SubtotalOptions>

The subtotal options.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SubtotalOptions.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SubtotalOptions.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SubtotalOptions.Builder`	`builder()`
`String`	`customLabel()` The custom label string for the subtotal cells.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`PivotTableSubtotalLevel`	`fieldLevel()` The field level (all, custom, last) for the subtotal cells.
`String`	`fieldLevelAsString()` The field level (all, custom, last) for the subtotal cells.
`List<PivotTableFieldSubtotalOptions>`	`fieldLevelOptions()` The optional configuration of subtotal cells.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFieldLevelOptions()` For responses, this returns true if the service returned a value for the FieldLevelOptions property.
`int`	`hashCode()`
`boolean`	`hasStyleTargets()` For responses, this returns true if the service returned a value for the StyleTargets property.
`TableCellStyle`	`metricHeaderCellStyle()` The cell styling options for the subtotals of header cells.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SubtotalOptions.Builder>`	`serializableBuilderClass()`
`List<TableStyleTarget>`	`styleTargets()` The style targets options for subtotals.
`SubtotalOptions.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TableCellStyle`	`totalCellStyle()` The cell styling options for the subtotal cells.
`Visibility`	`totalsVisibility()` The visibility configuration for the subtotal cells.
`String`	`totalsVisibilityAsString()` The visibility configuration for the subtotal cells.
`TableCellStyle`	`valueCellStyle()` The cell styling options for the subtotals 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 subtotal 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 subtotal cells.
    
    See Also:
    
    Visibility
  - totalsVisibilityAsString
```
public final String totalsVisibilityAsString()
```
    The visibility configuration for the subtotal 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 subtotal cells.
    
    See Also:
    
    Visibility
  - customLabel
```
public final String customLabel()
```
    The custom label string for the subtotal cells.
    
    Returns:
    
    The custom label string for the subtotal cells.
  - fieldLevel
```
public final PivotTableSubtotalLevel fieldLevel()
```
    The field level (all, custom, last) for the subtotal cells.
    
    If the service returns an enum value that is not available in the current SDK version, fieldLevel will return PivotTableSubtotalLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fieldLevelAsString().
    
    Returns:
    
    The field level (all, custom, last) for the subtotal cells.
    
    See Also:
    
    PivotTableSubtotalLevel
  - fieldLevelAsString
```
public final String fieldLevelAsString()
```
    The field level (all, custom, last) for the subtotal cells.
    
    If the service returns an enum value that is not available in the current SDK version, fieldLevel will return PivotTableSubtotalLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fieldLevelAsString().
    
    Returns:
    
    The field level (all, custom, last) for the subtotal cells.
    
    See Also:
    
    PivotTableSubtotalLevel
  - hasFieldLevelOptions
```
public final boolean hasFieldLevelOptions()
```
    For responses, this returns true if the service returned a value for the FieldLevelOptions 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.
  - fieldLevelOptions
```
public final List<PivotTableFieldSubtotalOptions> fieldLevelOptions()
```
    The optional configuration of subtotal cells.
    
    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 hasFieldLevelOptions() method.
    
    Returns:
    
    The optional configuration of subtotal cells.
  - totalCellStyle
```
public final TableCellStyle totalCellStyle()
```
    The cell styling options for the subtotal cells.
    
    Returns:
    
    The cell styling options for the subtotal cells.
  - valueCellStyle
```
public final TableCellStyle valueCellStyle()
```
    The cell styling options for the subtotals of value cells.
    
    Returns:
    
    The cell styling options for the subtotals of value cells.
  - metricHeaderCellStyle
```
public final TableCellStyle metricHeaderCellStyle()
```
    The cell styling options for the subtotals of header cells.
    
    Returns:
    
    The cell styling options for the subtotals of header cells.
  - hasStyleTargets
```
public final boolean hasStyleTargets()
```
    For responses, this returns true if the service returned a value for the StyleTargets 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.
  - styleTargets
```
public final List<TableStyleTarget> styleTargets()
```
    The style targets options for subtotals.
    
    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 hasStyleTargets() method.
    
    Returns:
    
    The style targets options for subtotals.
  - toBuilder
```
public SubtotalOptions.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SubtotalOptions.Builder,SubtotalOptions>
  - builder
```
public static SubtotalOptions.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SubtotalOptions.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 SubtotalOptions

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

customLabel

fieldLevel

fieldLevelAsString

hasFieldLevelOptions

fieldLevelOptions

totalCellStyle

valueCellStyle

metricHeaderCellStyle

hasStyleTargets

styleTargets

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields