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()
boolean	equals(Object obj)
String	getAwsAccountId() The ID of the AWS 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:
String	getName() The display name of the dashboard.
Parameters	getParameters() A structure that contains the parameters of the dashboard.
DashboardSourceEntity	getSourceEntity() The template or analysis from which the dashboard is created.
String	getVersionDescription() A description for the first version of the dashboard being created.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID of the AWS 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	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 template or analysis from which the dashboard is created.
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 AWS 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	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 template or analysis from which the dashboard is created.
UpdateDashboardRequest	withVersionDescription(String versionDescription) A description for the first version of the dashboard being created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDashboardRequest

public UpdateDashboardRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

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

Parameters:

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

getAwsAccountId

public String getAwsAccountId()

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.

withAwsAccountId

public UpdateDashboardRequest withAwsAccountId(String awsAccountId)

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

Parameters:

awsAccountId - The ID of the AWS 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 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:

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.

getSourceEntity

public DashboardSourceEntity getSourceEntity()

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.

withSourceEntity

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

Parameters:

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:

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.

Parameters:

parameters - A structure that contains the parameters of the dashboard.

getParameters

public Parameters getParameters()

A structure that contains the parameters of the dashboard.

Returns:

A structure that contains the parameters of the dashboard.

withParameters

public UpdateDashboardRequest withParameters(Parameters parameters)

A structure that contains the parameters of the dashboard.

Parameters:

parameters - A structure that contains the parameters of the dashboard.

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, 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.

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, 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.

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, 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.

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, 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.

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, 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:

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

Overrides:

clone in class AmazonWebServiceRequest