KPIOptions (AWS Java SDK for Amazon QuickSight 1.12.529 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KPIOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The options that determine the presentation of a KPI visual.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KPIOptions()

Constructors
Constructor and Description
`KPIOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KPIOptions`	`clone()`
`boolean`	`equals(Object obj)`
`ComparisonConfiguration`	`getComparison()` The comparison configuration of a KPI visual.
`String`	`getPrimaryValueDisplayType()` The options that determine the primary value display type.
`FontConfiguration`	`getPrimaryValueFontConfiguration()` The options that determine the primary value font configuration.
`ProgressBarOptions`	`getProgressBar()` The options that determine the presentation of the progress bar of a KPI visual.
`SecondaryValueOptions`	`getSecondaryValue()` The options that determine the presentation of the secondary value of a KPI visual.
`FontConfiguration`	`getSecondaryValueFontConfiguration()` The options that determine the secondary value font configuration.
`TrendArrowOptions`	`getTrendArrows()` The options that determine the presentation of trend arrows in a KPI visual.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setComparison(ComparisonConfiguration comparison)` The comparison configuration of a KPI visual.
`void`	`setPrimaryValueDisplayType(String primaryValueDisplayType)` The options that determine the primary value display type.
`void`	`setPrimaryValueFontConfiguration(FontConfiguration primaryValueFontConfiguration)` The options that determine the primary value font configuration.
`void`	`setProgressBar(ProgressBarOptions progressBar)` The options that determine the presentation of the progress bar of a KPI visual.
`void`	`setSecondaryValue(SecondaryValueOptions secondaryValue)` The options that determine the presentation of the secondary value of a KPI visual.
`void`	`setSecondaryValueFontConfiguration(FontConfiguration secondaryValueFontConfiguration)` The options that determine the secondary value font configuration.
`void`	`setTrendArrows(TrendArrowOptions trendArrows)` The options that determine the presentation of trend arrows in a KPI visual.
`String`	`toString()` Returns a string representation of this object.
`KPIOptions`	`withComparison(ComparisonConfiguration comparison)` The comparison configuration of a KPI visual.
`KPIOptions`	`withPrimaryValueDisplayType(PrimaryValueDisplayType primaryValueDisplayType)` The options that determine the primary value display type.
`KPIOptions`	`withPrimaryValueDisplayType(String primaryValueDisplayType)` The options that determine the primary value display type.
`KPIOptions`	`withPrimaryValueFontConfiguration(FontConfiguration primaryValueFontConfiguration)` The options that determine the primary value font configuration.
`KPIOptions`	`withProgressBar(ProgressBarOptions progressBar)` The options that determine the presentation of the progress bar of a KPI visual.
`KPIOptions`	`withSecondaryValue(SecondaryValueOptions secondaryValue)` The options that determine the presentation of the secondary value of a KPI visual.
`KPIOptions`	`withSecondaryValueFontConfiguration(FontConfiguration secondaryValueFontConfiguration)` The options that determine the secondary value font configuration.
`KPIOptions`	`withTrendArrows(TrendArrowOptions trendArrows)` The options that determine the presentation of trend arrows in a KPI visual.

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

- Constructor Detail
  - KPIOptions
```
public KPIOptions()
```
- Method Detail
  - setProgressBar
```
public void setProgressBar(ProgressBarOptions progressBar)
```
    The options that determine the presentation of the progress bar of a KPI visual.
    
    Parameters:
    
    progressBar - The options that determine the presentation of the progress bar of a KPI visual.
  - getProgressBar
```
public ProgressBarOptions getProgressBar()
```
    The options that determine the presentation of the progress bar of a KPI visual.
    
    Returns:
    
    The options that determine the presentation of the progress bar of a KPI visual.
  - withProgressBar
```
public KPIOptions withProgressBar(ProgressBarOptions progressBar)
```
    The options that determine the presentation of the progress bar of a KPI visual.
    
    Parameters:
    
    progressBar - The options that determine the presentation of the progress bar of a KPI visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrendArrows
```
public void setTrendArrows(TrendArrowOptions trendArrows)
```
    The options that determine the presentation of trend arrows in a KPI visual.
    
    Parameters:
    
    trendArrows - The options that determine the presentation of trend arrows in a KPI visual.
  - getTrendArrows
```
public TrendArrowOptions getTrendArrows()
```
    The options that determine the presentation of trend arrows in a KPI visual.
    
    Returns:
    
    The options that determine the presentation of trend arrows in a KPI visual.
  - withTrendArrows
```
public KPIOptions withTrendArrows(TrendArrowOptions trendArrows)
```
    The options that determine the presentation of trend arrows in a KPI visual.
    
    Parameters:
    
    trendArrows - The options that determine the presentation of trend arrows in a KPI visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecondaryValue
```
public void setSecondaryValue(SecondaryValueOptions secondaryValue)
```
    The options that determine the presentation of the secondary value of a KPI visual.
    
    Parameters:
    
    secondaryValue - The options that determine the presentation of the secondary value of a KPI visual.
  - getSecondaryValue
```
public SecondaryValueOptions getSecondaryValue()
```
    The options that determine the presentation of the secondary value of a KPI visual.
    
    Returns:
    
    The options that determine the presentation of the secondary value of a KPI visual.
  - withSecondaryValue
```
public KPIOptions withSecondaryValue(SecondaryValueOptions secondaryValue)
```
    The options that determine the presentation of the secondary value of a KPI visual.
    
    Parameters:
    
    secondaryValue - The options that determine the presentation of the secondary value of a KPI visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComparison
```
public void setComparison(ComparisonConfiguration comparison)
```
    The comparison configuration of a KPI visual.
    
    Parameters:
    
    comparison - The comparison configuration of a KPI visual.
  - getComparison
```
public ComparisonConfiguration getComparison()
```
    The comparison configuration of a KPI visual.
    
    Returns:
    
    The comparison configuration of a KPI visual.
  - withComparison
```
public KPIOptions withComparison(ComparisonConfiguration comparison)
```
    The comparison configuration of a KPI visual.
    
    Parameters:
    
    comparison - The comparison configuration of a KPI visual.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrimaryValueDisplayType
```
public void setPrimaryValueDisplayType(String primaryValueDisplayType)
```
    The options that determine the primary value display type.
    
    Parameters:
    
    primaryValueDisplayType - The options that determine the primary value display type.
    
    See Also:
    
    PrimaryValueDisplayType
  - getPrimaryValueDisplayType
```
public String getPrimaryValueDisplayType()
```
    The options that determine the primary value display type.
    
    Returns:
    
    The options that determine the primary value display type.
    
    See Also:
    
    PrimaryValueDisplayType
  - withPrimaryValueDisplayType
```
public KPIOptions withPrimaryValueDisplayType(String primaryValueDisplayType)
```
    The options that determine the primary value display type.
    
    Parameters:
    
    primaryValueDisplayType - The options that determine the primary value display type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PrimaryValueDisplayType
  - withPrimaryValueDisplayType
```
public KPIOptions withPrimaryValueDisplayType(PrimaryValueDisplayType primaryValueDisplayType)
```
    The options that determine the primary value display type.
    
    Parameters:
    
    primaryValueDisplayType - The options that determine the primary value display type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PrimaryValueDisplayType
  - setPrimaryValueFontConfiguration
```
public void setPrimaryValueFontConfiguration(FontConfiguration primaryValueFontConfiguration)
```
    The options that determine the primary value font configuration.
    
    Parameters:
    
    primaryValueFontConfiguration - The options that determine the primary value font configuration.
  - getPrimaryValueFontConfiguration
```
public FontConfiguration getPrimaryValueFontConfiguration()
```
    The options that determine the primary value font configuration.
    
    Returns:
    
    The options that determine the primary value font configuration.
  - withPrimaryValueFontConfiguration
```
public KPIOptions withPrimaryValueFontConfiguration(FontConfiguration primaryValueFontConfiguration)
```
    The options that determine the primary value font configuration.
    
    Parameters:
    
    primaryValueFontConfiguration - The options that determine the primary value font configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecondaryValueFontConfiguration
```
public void setSecondaryValueFontConfiguration(FontConfiguration secondaryValueFontConfiguration)
```
    The options that determine the secondary value font configuration.
    
    Parameters:
    
    secondaryValueFontConfiguration - The options that determine the secondary value font configuration.
  - getSecondaryValueFontConfiguration
```
public FontConfiguration getSecondaryValueFontConfiguration()
```
    The options that determine the secondary value font configuration.
    
    Returns:
    
    The options that determine the secondary value font configuration.
  - withSecondaryValueFontConfiguration
```
public KPIOptions withSecondaryValueFontConfiguration(FontConfiguration secondaryValueFontConfiguration)
```
    The options that determine the secondary value font configuration.
    
    Parameters:
    
    secondaryValueFontConfiguration - The options that determine the secondary value font configuration.
    
    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 KPIOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class KPIOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KPIOptions

Method Detail

setProgressBar

getProgressBar

withProgressBar

setTrendArrows

getTrendArrows

withTrendArrows

setSecondaryValue

getSecondaryValue

withSecondaryValue

setComparison

getComparison

withComparison

setPrimaryValueDisplayType

getPrimaryValueDisplayType

withPrimaryValueDisplayType

withPrimaryValueDisplayType

setPrimaryValueFontConfiguration

getPrimaryValueFontConfiguration

withPrimaryValueFontConfiguration

setSecondaryValueFontConfiguration

getSecondaryValueFontConfiguration

withSecondaryValueFontConfiguration

toString

equals

hashCode

clone

marshall