TotalOptions (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The total options for a table visual.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TotalOptions()

Constructors
Constructor and Description
`TotalOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TotalOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomLabel()` The custom label string for the total cells.
`String`	`getPlacement()` The placement (start, end) for the total cells.
`String`	`getScrollStatus()` The scroll status (pinned, scrolled) for the total cells.
`List<TotalAggregationOption>`	`getTotalAggregationOptions()` The total aggregation settings for each value field.
`TableCellStyle`	`getTotalCellStyle()` Cell styling options for the total cells.
`String`	`getTotalsVisibility()` The visibility configuration for the total cells.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomLabel(String customLabel)` The custom label string for the total cells.
`void`	`setPlacement(String placement)` The placement (start, end) for the total cells.
`void`	`setScrollStatus(String scrollStatus)` The scroll status (pinned, scrolled) for the total cells.
`void`	`setTotalAggregationOptions(Collection<TotalAggregationOption> totalAggregationOptions)` The total aggregation settings for each value field.
`void`	`setTotalCellStyle(TableCellStyle totalCellStyle)` Cell styling options for the total cells.
`void`	`setTotalsVisibility(String totalsVisibility)` The visibility configuration for the total cells.
`String`	`toString()` Returns a string representation of this object.
`TotalOptions`	`withCustomLabel(String customLabel)` The custom label string for the total cells.
`TotalOptions`	`withPlacement(String placement)` The placement (start, end) for the total cells.
`TotalOptions`	`withPlacement(TableTotalsPlacement placement)` The placement (start, end) for the total cells.
`TotalOptions`	`withScrollStatus(String scrollStatus)` The scroll status (pinned, scrolled) for the total cells.
`TotalOptions`	`withScrollStatus(TableTotalsScrollStatus scrollStatus)` The scroll status (pinned, scrolled) for the total cells.
`TotalOptions`	`withTotalAggregationOptions(Collection<TotalAggregationOption> totalAggregationOptions)` The total aggregation settings for each value field.
`TotalOptions`	`withTotalAggregationOptions(TotalAggregationOption... totalAggregationOptions)` The total aggregation settings for each value field.
`TotalOptions`	`withTotalCellStyle(TableCellStyle totalCellStyle)` Cell styling options for the total cells.
`TotalOptions`	`withTotalsVisibility(String totalsVisibility)` The visibility configuration for the total cells.
`TotalOptions`	`withTotalsVisibility(Visibility totalsVisibility)` The visibility configuration for the total cells.

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

- Constructor Detail
  - TotalOptions
```
public TotalOptions()
```
- Method Detail
  - setTotalsVisibility
```
public void setTotalsVisibility(String totalsVisibility)
```
    The visibility configuration for the total cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the total cells.
    
    See Also:
    
    Visibility
  - getTotalsVisibility
```
public String getTotalsVisibility()
```
    The visibility configuration for the total cells.
    
    Returns:
    
    The visibility configuration for the total cells.
    
    See Also:
    
    Visibility
  - withTotalsVisibility
```
public TotalOptions withTotalsVisibility(String totalsVisibility)
```
    The visibility configuration for the total cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - withTotalsVisibility
```
public TotalOptions withTotalsVisibility(Visibility totalsVisibility)
```
    The visibility configuration for the total cells.
    
    Parameters:
    
    totalsVisibility - The visibility configuration for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - setPlacement
```
public void setPlacement(String placement)
```
    The placement (start, end) for the total cells.
    
    Parameters:
    
    placement - The placement (start, end) for the total cells.
    
    See Also:
    
    TableTotalsPlacement
  - getPlacement
```
public String getPlacement()
```
    The placement (start, end) for the total cells.
    
    Returns:
    
    The placement (start, end) for the total cells.
    
    See Also:
    
    TableTotalsPlacement
  - withPlacement
```
public TotalOptions withPlacement(String placement)
```
    The placement (start, end) for the total cells.
    
    Parameters:
    
    placement - The placement (start, end) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsPlacement
  - withPlacement
```
public TotalOptions withPlacement(TableTotalsPlacement placement)
```
    The placement (start, end) for the total cells.
    
    Parameters:
    
    placement - The placement (start, end) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsPlacement
  - setScrollStatus
```
public void setScrollStatus(String scrollStatus)
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Parameters:
    
    scrollStatus - The scroll status (pinned, scrolled) for the total cells.
    
    See Also:
    
    TableTotalsScrollStatus
  - getScrollStatus
```
public String getScrollStatus()
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Returns:
    
    The scroll status (pinned, scrolled) for the total cells.
    
    See Also:
    
    TableTotalsScrollStatus
  - withScrollStatus
```
public TotalOptions withScrollStatus(String scrollStatus)
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Parameters:
    
    scrollStatus - The scroll status (pinned, scrolled) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsScrollStatus
  - withScrollStatus
```
public TotalOptions withScrollStatus(TableTotalsScrollStatus scrollStatus)
```
    The scroll status (pinned, scrolled) for the total cells.
    
    Parameters:
    
    scrollStatus - The scroll status (pinned, scrolled) for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TableTotalsScrollStatus
  - setCustomLabel
```
public void setCustomLabel(String customLabel)
```
    The custom label string for the total cells.
    
    Parameters:
    
    customLabel - The custom label string for the total cells.
  - getCustomLabel
```
public String getCustomLabel()
```
    The custom label string for the total cells.
    
    Returns:
    
    The custom label string for the total cells.
  - withCustomLabel
```
public TotalOptions withCustomLabel(String customLabel)
```
    The custom label string for the total cells.
    
    Parameters:
    
    customLabel - The custom label string for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalCellStyle
```
public void setTotalCellStyle(TableCellStyle totalCellStyle)
```
    Cell styling options for the total cells.
    
    Parameters:
    
    totalCellStyle - Cell styling options for the total cells.
  - getTotalCellStyle
```
public TableCellStyle getTotalCellStyle()
```
    Cell styling options for the total cells.
    
    Returns:
    
    Cell styling options for the total cells.
  - withTotalCellStyle
```
public TotalOptions withTotalCellStyle(TableCellStyle totalCellStyle)
```
    Cell styling options for the total cells.
    
    Parameters:
    
    totalCellStyle - Cell styling options for the total cells.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTotalAggregationOptions
```
public List<TotalAggregationOption> getTotalAggregationOptions()
```
    The total aggregation settings for each value field.
    
    Returns:
    
    The total aggregation settings for each value field.
  - setTotalAggregationOptions
```
public void setTotalAggregationOptions(Collection<TotalAggregationOption> totalAggregationOptions)
```
    The total aggregation settings for each value field.
    
    Parameters:
    
    totalAggregationOptions - The total aggregation settings for each value field.
  - withTotalAggregationOptions
```
public TotalOptions withTotalAggregationOptions(TotalAggregationOption... totalAggregationOptions)
```
    The total aggregation settings for each value field.
    
    NOTE: This method appends the values to the existing list (if any). Use setTotalAggregationOptions(java.util.Collection) or withTotalAggregationOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    totalAggregationOptions - The total aggregation settings for each value field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTotalAggregationOptions
```
public TotalOptions withTotalAggregationOptions(Collection<TotalAggregationOption> totalAggregationOptions)
```
    The total aggregation settings for each value field.
    
    Parameters:
    
    totalAggregationOptions - The total aggregation settings for each value field.
    
    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 TotalOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class TotalOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TotalOptions

Method Detail

setTotalsVisibility

getTotalsVisibility

withTotalsVisibility

withTotalsVisibility

setPlacement

getPlacement

withPlacement

withPlacement

setScrollStatus

getScrollStatus

withScrollStatus

withScrollStatus

setCustomLabel

getCustomLabel

withCustomLabel

setTotalCellStyle

getTotalCellStyle

withTotalCellStyle

getTotalAggregationOptions

setTotalAggregationOptions

withTotalAggregationOptions

withTotalAggregationOptions

toString

equals

hashCode

clone

marshall