com.amazonaws.services.quicksight.model

Class UpdateDashboardRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.UpdateDashboardRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDashboardRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateDashboardRequest()

Method Summary

Modifier and Type	Method and Description
UpdateDashboardRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID of the Amazon Web Services account that contains the dashboard that you're updating.
String	getDashboardId() The ID for the dashboard.
DashboardPublishOptions	getDashboardPublishOptions() Options for publishing the dashboard when you create it:
DashboardVersionDefinition	getDefinition() The definition of a dashboard.
String	getName() The display name of the dashboard.
Parameters	getParameters() A structure that contains the parameters of the dashboard.
DashboardSourceEntity	getSourceEntity() The entity that you are using as a source when you update the dashboard.
String	getThemeArn() The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
ValidationStrategy	getValidationStrategy() The option to relax the validation needed to update a dashboard with definition objects.
String	getVersionDescription() A description for the first version of the dashboard being created.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the dashboard that you're updating.
void	setDashboardId(String dashboardId) The ID for the dashboard.
void	setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) Options for publishing the dashboard when you create it:
void	setDefinition(DashboardVersionDefinition definition) The definition of a dashboard.
void	setName(String name) The display name of the dashboard.
void	setParameters(Parameters parameters) A structure that contains the parameters of the dashboard.
void	setSourceEntity(DashboardSourceEntity sourceEntity) The entity that you are using as a source when you update the dashboard.
void	setThemeArn(String themeArn) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
void	setValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to update a dashboard with definition objects.
void	setVersionDescription(String versionDescription) A description for the first version of the dashboard being created.
String	toString() Returns a string representation of this object.
UpdateDashboardRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the dashboard that you're updating.
UpdateDashboardRequest	withDashboardId(String dashboardId) The ID for the dashboard.
UpdateDashboardRequest	withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) Options for publishing the dashboard when you create it:
UpdateDashboardRequest	withDefinition(DashboardVersionDefinition definition) The definition of a dashboard.
UpdateDashboardRequest	withName(String name) The display name of the dashboard.
UpdateDashboardRequest	withParameters(Parameters parameters) A structure that contains the parameters of the dashboard.
UpdateDashboardRequest	withSourceEntity(DashboardSourceEntity sourceEntity) The entity that you are using as a source when you update the dashboard.
UpdateDashboardRequest	withThemeArn(String themeArn) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
UpdateDashboardRequest	withValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to update a dashboard with definition objects.
UpdateDashboardRequest	withVersionDescription(String versionDescription) A description for the first version of the dashboard being created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDashboardRequest

public UpdateDashboardRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

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

Parameters:

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

getAwsAccountId

public String getAwsAccountId()

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.

withAwsAccountId

public UpdateDashboardRequest withAwsAccountId(String awsAccountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDashboardId

public void setDashboardId(String dashboardId)

The ID for the dashboard.

Parameters:

dashboardId - The ID for the dashboard.

getDashboardId

public String getDashboardId()

The ID for the dashboard.

Returns:

The ID for the dashboard.

withDashboardId

public UpdateDashboardRequest withDashboardId(String dashboardId)

The ID for the dashboard.

Parameters:

dashboardId - The ID for the dashboard.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The display name of the dashboard.

Parameters:

name - The display name of the dashboard.

getName

public String getName()

The display name of the dashboard.

Returns:

The display name of the dashboard.

withName

public UpdateDashboardRequest withName(String name)

The display name of the dashboard.

Parameters:

name - The display name of the dashboard.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceEntity

public void setSourceEntity(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.

Parameters:

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.

getSourceEntity

public DashboardSourceEntity getSourceEntity()

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.

withSourceEntity

public UpdateDashboardRequest withSourceEntity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setParameters

public void setParameters(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.

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.

getParameters

public Parameters getParameters()

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.

withParameters

public UpdateDashboardRequest withParameters(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.

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:

Returns a reference to this object so that method calls can be chained together.

setVersionDescription

public void setVersionDescription(String versionDescription)

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

Parameters:

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

getVersionDescription

public String getVersionDescription()

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

Returns:

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

withVersionDescription

public UpdateDashboardRequest withVersionDescription(String versionDescription)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDashboardPublishOptions

public void setDashboardPublishOptions(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.

Parameters:

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.

getDashboardPublishOptions

public DashboardPublishOptions getDashboardPublishOptions()

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.

withDashboardPublishOptions

public UpdateDashboardRequest withDashboardPublishOptions(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setThemeArn

public void setThemeArn(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.

Parameters:

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.

getThemeArn

public String getThemeArn()

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.

withThemeArn

public UpdateDashboardRequest withThemeArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDefinition

public void setDefinition(DashboardVersionDefinition definition)

The definition of a dashboard.

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

Parameters:

definition - The definition of a dashboard.

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

getDefinition

public DashboardVersionDefinition getDefinition()

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.

withDefinition

public UpdateDashboardRequest withDefinition(DashboardVersionDefinition definition)

The definition of a dashboard.

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

Parameters:

definition - The definition of a dashboard.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setValidationStrategy

public void setValidationStrategy(ValidationStrategy validationStrategy)

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Parameters:

validationStrategy - The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

getValidationStrategy

public ValidationStrategy getValidationStrategy()

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Returns:

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

withValidationStrategy

public UpdateDashboardRequest withValidationStrategy(ValidationStrategy validationStrategy)

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Parameters:

validationStrategy - The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateDashboardRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()