Class KPIVisual
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.KPIVisual
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KPIVisual.Builder,KPIVisual>
@Generated("software.amazon.awssdk:codegen") public final class KPIVisual extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KPIVisual.Builder,KPIVisual>
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
KPIVisual.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<VisualCustomAction>
actions()
The list of custom actions that are configured for a visual.static KPIVisual.Builder
builder()
KPIConfiguration
chartConfiguration()
The configuration of a KPI visual.List<ColumnHierarchy>
columnHierarchies()
The column hierarchy that is used during drill-downs and drill-ups.KPIConditionalFormatting
conditionalFormatting()
The conditional formatting of a KPI visual.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasActions()
For responses, this returns true if the service returned a value for the Actions property.boolean
hasColumnHierarchies()
For responses, this returns true if the service returned a value for the ColumnHierarchies property.int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends KPIVisual.Builder>
serializableBuilderClass()
VisualSubtitleLabelOptions
subtitle()
The subtitle that is displayed on the visual.VisualTitleLabelOptions
title()
The title that is displayed on the visual.KPIVisual.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
visualId()
The unique identifier of a visual.-
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
-
visualId
public final String visualId()
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
- Returns:
- The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
-
title
public final VisualTitleLabelOptions title()
The title that is displayed on the visual.
- Returns:
- The title that is displayed on the visual.
-
subtitle
public final VisualSubtitleLabelOptions subtitle()
The subtitle that is displayed on the visual.
- Returns:
- The subtitle that is displayed on the visual.
-
chartConfiguration
public final KPIConfiguration chartConfiguration()
The configuration of a KPI visual.
- Returns:
- The configuration of a KPI visual.
-
conditionalFormatting
public final KPIConditionalFormatting conditionalFormatting()
The conditional formatting of a KPI visual.
- Returns:
- The conditional formatting of a KPI visual.
-
hasActions
public final boolean hasActions()
For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
actions
public final List<VisualCustomAction> actions()
The list of custom actions that are configured for a visual.
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
hasActions()
method.- Returns:
- The list of custom actions that are configured for a visual.
-
hasColumnHierarchies
public final boolean hasColumnHierarchies()
For responses, this returns true if the service returned a value for the ColumnHierarchies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
columnHierarchies
public final List<ColumnHierarchy> columnHierarchies()
The column hierarchy that is used during drill-downs and drill-ups.
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
hasColumnHierarchies()
method.- Returns:
- The column hierarchy that is used during drill-downs and drill-ups.
-
toBuilder
public KPIVisual.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<KPIVisual.Builder,KPIVisual>
-
builder
public static KPIVisual.Builder builder()
-
serializableBuilderClass
public static Class<? extends KPIVisual.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-