SubtotalOptions (AWS Java SDK for Amazon QuickSight 1.12.724 API)

java.lang.Object
- com.amazonaws.services.quicksight.model.SubtotalOptions

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SubtotalOptions
extends Object
implements Serializable, Cloneable, StructuredPojo

The subtotal options.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SubtotalOptions()

Constructors
Constructor and Description
`SubtotalOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubtotalOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomLabel()` The custom label string for the subtotal cells.
`String`	`getFieldLevel()` The field level (all, custom, last) for the subtotal cells.
`List<PivotTableFieldSubtotalOptions>`	`getFieldLevelOptions()` The optional configuration of subtotal cells.
`TableCellStyle`	`getMetricHeaderCellStyle()` The cell styling options for the subtotals of header cells.
`List<TableStyleTarget>`	`getStyleTargets()` The style targets options for subtotals.
`TableCellStyle`	`getTotalCellStyle()` The cell styling options for the subtotal cells.
`String`	`getTotalsVisibility()` The visibility configuration for the subtotal cells.
`TableCellStyle`	`getValueCellStyle()` The cell styling options for the subtotals of value cells.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCustomLabel(String customLabel)` The custom label string for the subtotal cells.
`void`	`setFieldLevel(String fieldLevel)` The field level (all, custom, last) for the subtotal cells.
`void`	`setFieldLevelOptions(Collection<PivotTableFieldSubtotalOptions> fieldLevelOptions)` The optional configuration of subtotal cells.
`void`	`setMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)` The cell styling options for the subtotals of header cells.
`void`	`setStyleTargets(Collection<TableStyleTarget> styleTargets)` The style targets options for subtotals.
`void`	`setTotalCellStyle(TableCellStyle totalCellStyle)` The cell styling options for the subtotal cells.
`void`	`setTotalsVisibility(String totalsVisibility)` The visibility configuration for the subtotal cells.
`void`	`setValueCellStyle(TableCellStyle valueCellStyle)` The cell styling options for the subtotals of value cells.
`String`	`toString()` Returns a string representation of this object.
`SubtotalOptions`	`withCustomLabel(String customLabel)` The custom label string for the subtotal cells.
`SubtotalOptions`	`withFieldLevel(PivotTableSubtotalLevel fieldLevel)` The field level (all, custom, last) for the subtotal cells.
`SubtotalOptions`	`withFieldLevel(String fieldLevel)` The field level (all, custom, last) for the subtotal cells.
`SubtotalOptions`	`withFieldLevelOptions(Collection<PivotTableFieldSubtotalOptions> fieldLevelOptions)` The optional configuration of subtotal cells.
`SubtotalOptions`	`withFieldLevelOptions(PivotTableFieldSubtotalOptions... fieldLevelOptions)` The optional configuration of subtotal cells.
`SubtotalOptions`	`withMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)` The cell styling options for the subtotals of header cells.
`SubtotalOptions`	`withStyleTargets(Collection<TableStyleTarget> styleTargets)` The style targets options for subtotals.
`SubtotalOptions`	`withStyleTargets(TableStyleTarget... styleTargets)` The style targets options for subtotals.
`SubtotalOptions`	`withTotalCellStyle(TableCellStyle totalCellStyle)` The cell styling options for the subtotal cells.
`SubtotalOptions`	`withTotalsVisibility(String totalsVisibility)` The visibility configuration for the subtotal cells.
`SubtotalOptions`	`withTotalsVisibility(Visibility totalsVisibility)` The visibility configuration for the subtotal cells.
`SubtotalOptions`	`withValueCellStyle(TableCellStyle valueCellStyle)` The cell styling options for the subtotals of value cells.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SubtotalOptions
```
public SubtotalOptions()
```
- Method Detail
  - setTotalsVisibility
```
public void setTotalsVisibility(String totalsVisibility)
```
    The visibility configuration for the subtotal cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the subtotal cells.
    
    See Also:
    
    Visibility
  - getTotalsVisibility
```
public String getTotalsVisibility()
```
    The visibility configuration for the subtotal cells.
    
    Returns:
    
    The visibility configuration for the subtotal cells.
    
    See Also:
    
    Visibility
  - withTotalsVisibility
```
public SubtotalOptions withTotalsVisibility(String totalsVisibility)
```
    The visibility configuration for the subtotal cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - withTotalsVisibility
```
public SubtotalOptions withTotalsVisibility(Visibility totalsVisibility)
```
    The visibility configuration for the subtotal cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - setCustomLabel
```
public void setCustomLabel(String customLabel)
```
    The custom label string for the subtotal cells.
    
    Parameters:
    
    customLabel - The custom label string for the subtotal cells.
  - getCustomLabel
```
public String getCustomLabel()
```
    The custom label string for the subtotal cells.
    
    Returns:
    
    The custom label string for the subtotal cells.
  - withCustomLabel
```
public SubtotalOptions withCustomLabel(String customLabel)
```
    The custom label string for the subtotal cells.
    
    Parameters:
    
    customLabel - The custom label string for the subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFieldLevel
```
public void setFieldLevel(String fieldLevel)
```
    The field level (all, custom, last) for the subtotal cells.
    
    Parameters:
    
    fieldLevel - The field level (all, custom, last) for the subtotal cells.
    
    See Also:
    
    PivotTableSubtotalLevel
  - getFieldLevel
```
public String getFieldLevel()
```
    The field level (all, custom, last) for the subtotal cells.
    
    Returns:
    
    The field level (all, custom, last) for the subtotal cells.
    
    See Also:
    
    PivotTableSubtotalLevel
  - withFieldLevel
```
public SubtotalOptions withFieldLevel(String fieldLevel)
```
    The field level (all, custom, last) for the subtotal cells.
    
    Parameters:
    
    fieldLevel - The field level (all, custom, last) for the subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PivotTableSubtotalLevel
  - withFieldLevel
```
public SubtotalOptions withFieldLevel(PivotTableSubtotalLevel fieldLevel)
```
    The field level (all, custom, last) for the subtotal cells.
    
    Parameters:
    
    fieldLevel - The field level (all, custom, last) for the subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PivotTableSubtotalLevel
  - getFieldLevelOptions
```
public List<PivotTableFieldSubtotalOptions> getFieldLevelOptions()
```
    The optional configuration of subtotal cells.
    
    Returns:
    
    The optional configuration of subtotal cells.
  - setFieldLevelOptions
```
public void setFieldLevelOptions(Collection<PivotTableFieldSubtotalOptions> fieldLevelOptions)
```
    The optional configuration of subtotal cells.
    
    Parameters:
    
    fieldLevelOptions - The optional configuration of subtotal cells.
  - withFieldLevelOptions
```
public SubtotalOptions withFieldLevelOptions(PivotTableFieldSubtotalOptions... fieldLevelOptions)
```
    The optional configuration of subtotal cells.
    
    NOTE: This method appends the values to the existing list (if any). Use setFieldLevelOptions(java.util.Collection) or withFieldLevelOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    fieldLevelOptions - The optional configuration of subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFieldLevelOptions
```
public SubtotalOptions withFieldLevelOptions(Collection<PivotTableFieldSubtotalOptions> fieldLevelOptions)
```
    The optional configuration of subtotal cells.
    
    Parameters:
    
    fieldLevelOptions - The optional configuration of subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalCellStyle
```
public void setTotalCellStyle(TableCellStyle totalCellStyle)
```
    The cell styling options for the subtotal cells.
    
    Parameters:
    
    totalCellStyle - The cell styling options for the subtotal cells.
  - getTotalCellStyle
```
public TableCellStyle getTotalCellStyle()
```
    The cell styling options for the subtotal cells.
    
    Returns:
    
    The cell styling options for the subtotal cells.
  - withTotalCellStyle
```
public SubtotalOptions withTotalCellStyle(TableCellStyle totalCellStyle)
```
    The cell styling options for the subtotal cells.
    
    Parameters:
    
    totalCellStyle - The cell styling options for the subtotal cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueCellStyle
```
public void setValueCellStyle(TableCellStyle valueCellStyle)
```
    The cell styling options for the subtotals of value cells.
    
    Parameters:
    
    valueCellStyle - The cell styling options for the subtotals of value cells.
  - getValueCellStyle
```
public TableCellStyle getValueCellStyle()
```
    The cell styling options for the subtotals of value cells.
    
    Returns:
    
    The cell styling options for the subtotals of value cells.
  - withValueCellStyle
```
public SubtotalOptions withValueCellStyle(TableCellStyle valueCellStyle)
```
    The cell styling options for the subtotals of value cells.
    
    Parameters:
    
    valueCellStyle - The cell styling options for the subtotals of value cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricHeaderCellStyle
```
public void setMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)
```
    The cell styling options for the subtotals of header cells.
    
    Parameters:
    
    metricHeaderCellStyle - The cell styling options for the subtotals of header cells.
  - getMetricHeaderCellStyle
```
public TableCellStyle getMetricHeaderCellStyle()
```
    The cell styling options for the subtotals of header cells.
    
    Returns:
    
    The cell styling options for the subtotals of header cells.
  - withMetricHeaderCellStyle
```
public SubtotalOptions withMetricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)
```
    The cell styling options for the subtotals of header cells.
    
    Parameters:
    
    metricHeaderCellStyle - The cell styling options for the subtotals of header cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStyleTargets
```
public List<TableStyleTarget> getStyleTargets()
```
    The style targets options for subtotals.
    
    Returns:
    
    The style targets options for subtotals.
  - setStyleTargets
```
public void setStyleTargets(Collection<TableStyleTarget> styleTargets)
```
    The style targets options for subtotals.
    
    Parameters:
    
    styleTargets - The style targets options for subtotals.
  - withStyleTargets
```
public SubtotalOptions withStyleTargets(TableStyleTarget... styleTargets)
```
    The style targets options for subtotals.
    
    NOTE: This method appends the values to the existing list (if any). Use setStyleTargets(java.util.Collection) or withStyleTargets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    styleTargets - The style targets options for subtotals.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStyleTargets
```
public SubtotalOptions withStyleTargets(Collection<TableStyleTarget> styleTargets)
```
    The style targets options for subtotals.
    
    Parameters:
    
    styleTargets - The style targets options for subtotals.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SubtotalOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SubtotalOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubtotalOptions

Method Detail

setTotalsVisibility

getTotalsVisibility

withTotalsVisibility

withTotalsVisibility

setCustomLabel

getCustomLabel

withCustomLabel

setFieldLevel

getFieldLevel

withFieldLevel

withFieldLevel

getFieldLevelOptions

setFieldLevelOptions

withFieldLevelOptions

withFieldLevelOptions

setTotalCellStyle

getTotalCellStyle

withTotalCellStyle

setValueCellStyle

getValueCellStyle

withValueCellStyle

setMetricHeaderCellStyle

getMetricHeaderCellStyle

withMetricHeaderCellStyle

getStyleTargets

setStyleTargets

withStyleTargets

withStyleTargets

toString

equals

hashCode

clone

marshall