Package software.amazon.awssdk.services.quicksight.model

Class PluginVisual

java.lang.Object

software.amazon.awssdk.services.quicksight.model.PluginVisual

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PluginVisual.Builder,PluginVisual>

@Generated("software.amazon.awssdk:codegen")
public final class PluginVisual
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PluginVisual.Builder,PluginVisual>

A flexible visualization type that allows engineers to create new custom charts in QuickSight.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PluginVisual.Builder

Method Summary

Modifier and Type	Method	Description
List<VisualCustomAction>	actions()	The list of custom actions that are configured for a visual.
static PluginVisual.Builder	builder()
PluginVisualConfiguration	chartConfiguration()	A description of the plugin field wells and their persisted properties.
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.
int	hashCode()
String	pluginArn()	The Amazon Resource Name (ARN) that reflects the plugin and version.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PluginVisual.Builder>	serializableBuilderClass()
VisualSubtitleLabelOptions	subtitle()	Returns the value of the Subtitle property for this object.
VisualTitleLabelOptions	title()	Returns the value of the Title property for this object.
PluginVisual.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	visualContentAltText()	The alt text for the visual.
String	visualId()	The ID of the visual that you want to use.

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 ID of the visual that you want to use.

Returns:

The ID of the visual that you want to use.

pluginArn

public final String pluginArn()

The Amazon Resource Name (ARN) that reflects the plugin and version.

Returns:

The Amazon Resource Name (ARN) that reflects the plugin and version.

title

public final VisualTitleLabelOptions title()

Returns the value of the Title property for this object.

Returns:

The value of the Title property for this object.

subtitle

public final VisualSubtitleLabelOptions subtitle()

Returns the value of the Subtitle property for this object.

Returns:

The value of the Subtitle property for this object.

chartConfiguration

public final PluginVisualConfiguration chartConfiguration()

A description of the plugin field wells and their persisted properties.

Returns:

A description of the plugin field wells and their persisted properties.

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 the isEmpty() 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.

visualContentAltText

public final String visualContentAltText()

The alt text for the visual.

Returns:

The alt text for the visual.

toBuilder

public PluginVisual.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PluginVisual.Builder,PluginVisual>

builder

public static PluginVisual.Builder builder()

serializableBuilderClass

public static Class<? extends PluginVisual.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo