com.amazonaws.services.quicksight.model

Class CreateDashboardRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.CreateDashboardRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDashboardRequest
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
CreateDashboardRequest()

Method Summary

Modifier and Type	Method and Description
CreateDashboardRequest	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 where you want to create the dashboard.
String	getDashboardId() The ID for the dashboard, also added to the IAM policy.
DashboardPublishOptions	getDashboardPublishOptions() Options for publishing the dashboard when you create it:
DashboardVersionDefinition	getDefinition() The definition of a dashboard.
List<String>	getFolderArns() When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
List<String>	getLinkEntities() A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
LinkSharingConfiguration	getLinkSharingConfiguration() A structure that contains the permissions of a shareable link to the dashboard.
String	getName() The display name of the dashboard.
Parameters	getParameters() The parameters for the creation of the dashboard, which you want to use to override the default settings.
List<ResourcePermission>	getPermissions() A structure that contains the permissions of the dashboard.
DashboardSourceEntity	getSourceEntity() The entity that you are using as a source when you create the dashboard.
List<Tag>	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to 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 create 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 where you want to create the dashboard.
void	setDashboardId(String dashboardId) The ID for the dashboard, also added to the IAM policy.
void	setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) Options for publishing the dashboard when you create it:
void	setDefinition(DashboardVersionDefinition definition) The definition of a dashboard.
void	setFolderArns(Collection<String> folderArns) When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
void	setLinkEntities(Collection<String> linkEntities) A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
void	setLinkSharingConfiguration(LinkSharingConfiguration linkSharingConfiguration) A structure that contains the permissions of a shareable link to the dashboard.
void	setName(String name) The display name of the dashboard.
void	setParameters(Parameters parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.
void	setPermissions(Collection<ResourcePermission> permissions) A structure that contains the permissions of the dashboard.
void	setSourceEntity(DashboardSourceEntity sourceEntity) The entity that you are using as a source when you create the dashboard.
void	setTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to 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 create 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.
CreateDashboardRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account where you want to create the dashboard.
CreateDashboardRequest	withDashboardId(String dashboardId) The ID for the dashboard, also added to the IAM policy.
CreateDashboardRequest	withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) Options for publishing the dashboard when you create it:
CreateDashboardRequest	withDefinition(DashboardVersionDefinition definition) The definition of a dashboard.
CreateDashboardRequest	withFolderArns(Collection<String> folderArns) When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
CreateDashboardRequest	withFolderArns(String... folderArns) When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
CreateDashboardRequest	withLinkEntities(Collection<String> linkEntities) A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
CreateDashboardRequest	withLinkEntities(String... linkEntities) A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
CreateDashboardRequest	withLinkSharingConfiguration(LinkSharingConfiguration linkSharingConfiguration) A structure that contains the permissions of a shareable link to the dashboard.
CreateDashboardRequest	withName(String name) The display name of the dashboard.
CreateDashboardRequest	withParameters(Parameters parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.
CreateDashboardRequest	withPermissions(Collection<ResourcePermission> permissions) A structure that contains the permissions of the dashboard.
CreateDashboardRequest	withPermissions(ResourcePermission... permissions) A structure that contains the permissions of the dashboard.
CreateDashboardRequest	withSourceEntity(DashboardSourceEntity sourceEntity) The entity that you are using as a source when you create the dashboard.
CreateDashboardRequest	withTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
CreateDashboardRequest	withTags(Tag... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
CreateDashboardRequest	withThemeArn(String themeArn) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
CreateDashboardRequest	withValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to create a dashboard with definition objects.
CreateDashboardRequest	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

CreateDashboardRequest

public CreateDashboardRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The ID of the Amazon Web Services account where you want to create the dashboard.

Parameters:

awsAccountId - The ID of the Amazon Web Services account where you want to create the dashboard.

getAwsAccountId

public String getAwsAccountId()

The ID of the Amazon Web Services account where you want to create the dashboard.

Returns:

The ID of the Amazon Web Services account where you want to create the dashboard.

withAwsAccountId

public CreateDashboardRequest withAwsAccountId(String awsAccountId)

The ID of the Amazon Web Services account where you want to create the dashboard.

Parameters:

awsAccountId - The ID of the Amazon Web Services account where you want to create the dashboard.

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, also added to the IAM policy.

Parameters:

dashboardId - The ID for the dashboard, also added to the IAM policy.

getDashboardId

public String getDashboardId()

The ID for the dashboard, also added to the IAM policy.

Returns:

The ID for the dashboard, also added to the IAM policy.

withDashboardId

public CreateDashboardRequest withDashboardId(String dashboardId)

The ID for the dashboard, also added to the IAM policy.

Parameters:

dashboardId - The ID for the dashboard, also added to the IAM policy.

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

setParameters

public void setParameters(Parameters parameters)

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Parameters:

parameters - The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

getParameters

public Parameters getParameters()

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Returns:

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

withParameters

public CreateDashboardRequest withParameters(Parameters parameters)

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Parameters:

parameters - The parameters for the creation of the dashboard, which you want to use to override the default settings. 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.

getPermissions

public List<ResourcePermission> getPermissions()

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Returns:

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

setPermissions

public void setPermissions(Collection<ResourcePermission> permissions)

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Parameters:

permissions - A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

withPermissions

public CreateDashboardRequest withPermissions(ResourcePermission... permissions)

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

NOTE: This method appends the values to the existing list (if any). Use setPermissions(java.util.Collection) or withPermissions(java.util.Collection) if you want to override the existing values.

Parameters:

permissions - A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Returns:

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

withPermissions

public CreateDashboardRequest withPermissions(Collection<ResourcePermission> permissions)

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Parameters:

permissions - A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

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 create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

sourceEntity - The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

getSourceEntity

public DashboardSourceEntity getSourceEntity()

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

withSourceEntity

public CreateDashboardRequest withSourceEntity(DashboardSourceEntity sourceEntity)

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

sourceEntity - The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

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

getTags

public List<Tag> getTags()

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Returns:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

setTags

public void setTags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

withTags

public CreateDashboardRequest withTags(Tag... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Returns:

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

withTags

public CreateDashboardRequest withTags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to 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 CreateDashboardRequest 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 CreateDashboardRequest 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 is used in the source 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 is used in the source 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 is used in the source 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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

withThemeArn

public CreateDashboardRequest 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 is used in the source 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 is used in the source 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

definition - The definition of a dashboard.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

getDefinition

public DashboardVersionDefinition getDefinition()

The definition of a dashboard.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

The definition of a dashboard.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

withDefinition

public CreateDashboardRequest withDefinition(DashboardVersionDefinition definition)

The definition of a dashboard.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

definition - The definition of a dashboard.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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 create a dashboard with definition objects. This option skips the validation step for specific errors.

Parameters:

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

getValidationStrategy

public ValidationStrategy getValidationStrategy()

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

Returns:

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

withValidationStrategy

public CreateDashboardRequest withValidationStrategy(ValidationStrategy validationStrategy)

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

Parameters:

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

Returns:

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

getFolderArns

public List<String> getFolderArns()

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

Returns:

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

setFolderArns

public void setFolderArns(Collection<String> folderArns)

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

Parameters:

folderArns - When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

withFolderArns

public CreateDashboardRequest withFolderArns(String... folderArns)

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

NOTE: This method appends the values to the existing list (if any). Use setFolderArns(java.util.Collection) or withFolderArns(java.util.Collection) if you want to override the existing values.

Parameters:

folderArns - When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

Returns:

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

withFolderArns

public CreateDashboardRequest withFolderArns(Collection<String> folderArns)

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

Parameters:

folderArns - When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

Returns:

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

setLinkSharingConfiguration

public void setLinkSharingConfiguration(LinkSharingConfiguration linkSharingConfiguration)

A structure that contains the permissions of a shareable link to the dashboard.

Parameters:

linkSharingConfiguration - A structure that contains the permissions of a shareable link to the dashboard.

getLinkSharingConfiguration

public LinkSharingConfiguration getLinkSharingConfiguration()

A structure that contains the permissions of a shareable link to the dashboard.

Returns:

A structure that contains the permissions of a shareable link to the dashboard.

withLinkSharingConfiguration

public CreateDashboardRequest withLinkSharingConfiguration(LinkSharingConfiguration linkSharingConfiguration)

A structure that contains the permissions of a shareable link to the dashboard.

Parameters:

linkSharingConfiguration - A structure that contains the permissions of a shareable link to the dashboard.

Returns:

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

getLinkEntities

public List<String> getLinkEntities()

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

setLinkEntities

public void setLinkEntities(Collection<String> linkEntities)

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Parameters:

linkEntities - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

withLinkEntities

public CreateDashboardRequest withLinkEntities(String... linkEntities)

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

NOTE: This method appends the values to the existing list (if any). Use setLinkEntities(java.util.Collection) or withLinkEntities(java.util.Collection) if you want to override the existing values.

Parameters:

linkEntities - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

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

withLinkEntities

public CreateDashboardRequest withLinkEntities(Collection<String> linkEntities)

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Parameters:

linkEntities - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

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