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 AWS 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:
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 template or analysis from which the dashboard is created.
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 String awsAccountId()

The ID of the AWS account that contains the dashboard that you're updating.

Returns:

The ID of the AWS account that contains the dashboard that you're updating.

dashboardId

public String dashboardId()

The ID for the dashboard.

Returns:

The ID for the dashboard.

name

public String name()

The display name of the dashboard.

Returns:

The display name of the dashboard.

sourceEntity

public DashboardSourceEntity sourceEntity()

The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

Returns:

The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

parameters

public Parameters parameters()

A structure that contains the parameters of the dashboard.

Returns:

A structure that contains the parameters of the dashboard.

versionDescription

public 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 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, 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. The sheet controls pane is collapsed by default when set to true. 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, 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. The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo