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

Class DashboardVisualId

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DashboardVisualId

All Implemented Interfaces:

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

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

A structure that contains the following elements:

• The DashboardId of the dashboard that has the visual that you want to embed.

• The SheetId of the sheet that has the visual that you want to embed.

• The VisualId of the visual that you want to embed.

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DashboardVisualId.Builder

Method Summary

Modifier and Type	Method	Description
static DashboardVisualId.Builder	builder()
String	dashboardId()	The ID of the dashboard that has the visual that you want to embed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DashboardVisualId.Builder>	serializableBuilderClass()
String	sheetId()	The ID of the sheet that the has visual that you want to embed.
DashboardVisualId.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	visualId()	The ID of the visual that you want to embed.

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

dashboardId

public final String dashboardId()

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

Returns:

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

sheetId

public final String sheetId()

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console.

Returns:

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console.

visualId

public final String visualId()

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console.

Returns:

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console.

toBuilder

public DashboardVisualId.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DashboardVisualId.Builder,DashboardVisualId>

builder

public static DashboardVisualId.Builder builder()

serializableBuilderClass

public static Class<? extends DashboardVisualId.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