software.amazon.awssdk.services.quicksight.model

Class UpdateDashboardRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.UpdateDashboardRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDashboardRequest.Builder,UpdateDashboardRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateDashboardRequest
extends QuickSightRequest
implements ToCopyableBuilder<UpdateDashboardRequest.Builder,UpdateDashboardRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDashboardRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID of the Amazon Web Services account that contains the dashboard that you're updating.
static UpdateDashboardRequest.Builder	builder()
String	dashboardId() The ID for the dashboard.
DashboardPublishOptions	dashboardPublishOptions() Options for publishing the dashboard when you create it:
DashboardVersionDefinition	definition() The definition of a dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The display name of the dashboard.
Parameters	parameters() A structure that contains the parameters of the dashboard.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDashboardRequest.Builder>	serializableBuilderClass()
DashboardSourceEntity	sourceEntity() The entity that you are using as a source when you update the dashboard.
String	themeArn() The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
UpdateDashboardRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionDescription() A description for the first version of the dashboard being created.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

awsAccountId

public final String awsAccountId()

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

Returns:

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

dashboardId

public final String dashboardId()

The ID for the dashboard.

Returns:

The ID for the dashboard.

name

public final String name()

The display name of the dashboard.

Returns:

The display name of the dashboard.

sourceEntity

public final DashboardSourceEntity sourceEntity()

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Returns:

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

parameters

public final Parameters parameters()

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Returns:

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

versionDescription

public final String versionDescription()

A description for the first version of the dashboard being created.

Returns:

A description for the first version of the dashboard being created.

dashboardPublishOptions

public final DashboardPublishOptions dashboardPublishOptions()

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Returns:

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

themeArn

public final String themeArn()

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Returns:

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

definition

public final DashboardVersionDefinition definition()

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Returns:

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

toBuilder

public UpdateDashboardRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDashboardRequest.Builder,UpdateDashboardRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static UpdateDashboardRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo