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 AWS 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:
String	getName() The display name of the dashboard.
Parameters	getParameters() A structure that contains the parameters of the dashboard.
List<ResourcePermission>	getPermissions() A structure that contains the permissions of the dashboard.
DashboardSourceEntity	getSourceEntity() The source entity from which the dashboard is created.
List<Tag>	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
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 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	setName(String name) The display name of the dashboard.
void	setParameters(Parameters parameters) A structure that contains the parameters of the dashboard.
void	setPermissions(Collection<ResourcePermission> permissions) A structure that contains the permissions of the dashboard.
void	setSourceEntity(DashboardSourceEntity sourceEntity) The source entity from which the dashboard is created.
void	setTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
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 AWS 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	withName(String name) The display name of the dashboard.
CreateDashboardRequest	withParameters(Parameters parameters) A structure that contains the parameters of the dashboard.
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 source entity from which the dashboard is created.
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	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 AWS account where you want to create the dashboard.

Parameters:

awsAccountId - The ID of the AWS account where you want to create the dashboard.

getAwsAccountId

public String getAwsAccountId()

The ID of the AWS account where you want to create the dashboard.

Returns:

The ID of the AWS account where you want to create the dashboard.

withAwsAccountId

public CreateDashboardRequest withAwsAccountId(String awsAccountId)

The ID of the AWS account where you want to create the dashboard.

Parameters:

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

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. You can use the dashboard permissions structure described following to override two string parameters that 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. You can use the dashboard permissions structure described following to override two string parameters that 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. You can use the dashboard permissions structure described following to override two string parameters that 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. You can use the dashboard permissions structure described following to override two string parameters that accept multiple values.

withParameters

public CreateDashboardRequest 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. You can use the dashboard permissions structure described following to override two string parameters that 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. You can use the dashboard permissions structure described following to override two string parameters that 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 with principal and action information.

Returns:

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.

setPermissions

public void setPermissions(Collection<ResourcePermission> permissions)

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.

Parameters:

permissions - A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.

withPermissions

public CreateDashboardRequest withPermissions(ResourcePermission... permissions)

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.

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 with principal and action information.

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 with principal and action information.

Parameters:

permissions - A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.

Returns:

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

setSourceEntity

public void setSourceEntity(DashboardSourceEntity sourceEntity)

The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the 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.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

Parameters:

sourceEntity - The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the 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.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

getSourceEntity

public DashboardSourceEntity getSourceEntity()

The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the 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.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

Returns:

The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the 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.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

withSourceEntity

public CreateDashboardRequest withSourceEntity(DashboardSourceEntity sourceEntity)

The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the 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.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

Parameters:

sourceEntity - The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the 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.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

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