@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CustomContentVisual extends Object implements Serializable, Cloneable, StructuredPojo
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon QuickSight User Guide.
Constructor and Description |
---|
CustomContentVisual() |
Modifier and Type | Method and Description |
---|---|
CustomContentVisual |
clone() |
boolean |
equals(Object obj) |
List<VisualCustomAction> |
getActions()
The list of custom actions that are configured for a visual.
|
CustomContentConfiguration |
getChartConfiguration()
The configuration of a
CustomContentVisual . |
String |
getDataSetIdentifier()
The dataset that is used to create the custom content visual.
|
VisualSubtitleLabelOptions |
getSubtitle()
The subtitle that is displayed on the visual.
|
VisualTitleLabelOptions |
getTitle()
The title that is displayed on the visual.
|
String |
getVisualId()
The unique identifier of a visual.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setActions(Collection<VisualCustomAction> actions)
The list of custom actions that are configured for a visual.
|
void |
setChartConfiguration(CustomContentConfiguration chartConfiguration)
The configuration of a
CustomContentVisual . |
void |
setDataSetIdentifier(String dataSetIdentifier)
The dataset that is used to create the custom content visual.
|
void |
setSubtitle(VisualSubtitleLabelOptions subtitle)
The subtitle that is displayed on the visual.
|
void |
setTitle(VisualTitleLabelOptions title)
The title that is displayed on the visual.
|
void |
setVisualId(String visualId)
The unique identifier of a visual.
|
String |
toString()
Returns a string representation of this object.
|
CustomContentVisual |
withActions(Collection<VisualCustomAction> actions)
The list of custom actions that are configured for a visual.
|
CustomContentVisual |
withActions(VisualCustomAction... actions)
The list of custom actions that are configured for a visual.
|
CustomContentVisual |
withChartConfiguration(CustomContentConfiguration chartConfiguration)
The configuration of a
CustomContentVisual . |
CustomContentVisual |
withDataSetIdentifier(String dataSetIdentifier)
The dataset that is used to create the custom content visual.
|
CustomContentVisual |
withSubtitle(VisualSubtitleLabelOptions subtitle)
The subtitle that is displayed on the visual.
|
CustomContentVisual |
withTitle(VisualTitleLabelOptions title)
The title that is displayed on the visual.
|
CustomContentVisual |
withVisualId(String visualId)
The unique identifier of a visual.
|
public void setVisualId(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.
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.public String getVisualId()
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.
public CustomContentVisual withVisualId(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.
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.public void setTitle(VisualTitleLabelOptions title)
The title that is displayed on the visual.
title
- The title that is displayed on the visual.public VisualTitleLabelOptions getTitle()
The title that is displayed on the visual.
public CustomContentVisual withTitle(VisualTitleLabelOptions title)
The title that is displayed on the visual.
title
- The title that is displayed on the visual.public void setSubtitle(VisualSubtitleLabelOptions subtitle)
The subtitle that is displayed on the visual.
subtitle
- The subtitle that is displayed on the visual.public VisualSubtitleLabelOptions getSubtitle()
The subtitle that is displayed on the visual.
public CustomContentVisual withSubtitle(VisualSubtitleLabelOptions subtitle)
The subtitle that is displayed on the visual.
subtitle
- The subtitle that is displayed on the visual.public void setChartConfiguration(CustomContentConfiguration chartConfiguration)
The configuration of a CustomContentVisual
.
chartConfiguration
- The configuration of a CustomContentVisual
.public CustomContentConfiguration getChartConfiguration()
The configuration of a CustomContentVisual
.
CustomContentVisual
.public CustomContentVisual withChartConfiguration(CustomContentConfiguration chartConfiguration)
The configuration of a CustomContentVisual
.
chartConfiguration
- The configuration of a CustomContentVisual
.public List<VisualCustomAction> getActions()
The list of custom actions that are configured for a visual.
public void setActions(Collection<VisualCustomAction> actions)
The list of custom actions that are configured for a visual.
actions
- The list of custom actions that are configured for a visual.public CustomContentVisual withActions(VisualCustomAction... actions)
The list of custom actions that are configured for a visual.
NOTE: This method appends the values to the existing list (if any). Use
setActions(java.util.Collection)
or withActions(java.util.Collection)
if you want to override
the existing values.
actions
- The list of custom actions that are configured for a visual.public CustomContentVisual withActions(Collection<VisualCustomAction> actions)
The list of custom actions that are configured for a visual.
actions
- The list of custom actions that are configured for a visual.public void setDataSetIdentifier(String dataSetIdentifier)
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
dataSetIdentifier
- The dataset that is used to create the custom content visual. You can't create a visual without a dataset.public String getDataSetIdentifier()
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
public CustomContentVisual withDataSetIdentifier(String dataSetIdentifier)
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
dataSetIdentifier
- The dataset that is used to create the custom content visual. You can't create a visual without a dataset.public String toString()
toString
in class Object
Object.toString()
public CustomContentVisual clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.