@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDashboardRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateDashboardRequest() |
| 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()
AWS account ID where you want to create the dashboard.
|
String |
getDashboardId()
The ID for the dashboard, also added to IAM policy.
|
DashboardPublishOptions |
getDashboardPublishOptions()
Publishing options when creating dashboard.
|
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()
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)
AWS account ID where you want to create the dashboard.
|
void |
setDashboardId(String dashboardId)
The ID for the dashboard, also added to IAM policy.
|
void |
setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating 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 |
setPermissions(Collection<ResourcePermission> permissions)
A structure that contains the permissions of the dashboard.
|
void |
setSourceEntity(DashboardSourceEntity sourceEntity)
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)
AWS account ID where you want to create the dashboard.
|
CreateDashboardRequest |
withDashboardId(String dashboardId)
The ID for the dashboard, also added to IAM policy.
|
CreateDashboardRequest |
withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating dashboard.
|
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)
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.
|
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, withSdkRequestTimeoutpublic void setAwsAccountId(String awsAccountId)
AWS account ID where you want to create the dashboard.
awsAccountId - AWS account ID where you want to create the dashboard.public String getAwsAccountId()
AWS account ID where you want to create the dashboard.
public CreateDashboardRequest withAwsAccountId(String awsAccountId)
AWS account ID where you want to create the dashboard.
awsAccountId - AWS account ID where you want to create the dashboard.public void setDashboardId(String dashboardId)
The ID for the dashboard, also added to IAM policy.
dashboardId - The ID for the dashboard, also added to IAM policy.public String getDashboardId()
The ID for the dashboard, also added to IAM policy.
public CreateDashboardRequest withDashboardId(String dashboardId)
The ID for the dashboard, also added to IAM policy.
dashboardId - The ID for the dashboard, also added to IAM policy.public void setName(String name)
The display name of the dashboard.
name - The display name of the dashboard.public String getName()
The display name of the dashboard.
public CreateDashboardRequest withName(String name)
The display name of the dashboard.
name - The display name of the dashboard.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 could use the following structure to override two string parameters that accept multiple values:
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 could
use the following structure to override two string parameters that accept multiple values: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 could use the following structure to override two string parameters that accept multiple values:
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 could use the following structure to override two string parameters that accept multiple values:
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 could
use the following structure to override two string parameters that accept multiple values:public List<ResourcePermission> getPermissions()
A structure that contains the permissions of the dashboard. You can use this for granting permissions with principal and action information.
public void setPermissions(Collection<ResourcePermission> permissions)
A structure that contains the permissions of the dashboard. You can use this for granting permissions with principal and action information.
permissions - A structure that contains the permissions of the dashboard. You can use this for granting permissions with
principal and action information.public CreateDashboardRequest withPermissions(ResourcePermission... permissions)
A structure that contains the permissions of the dashboard. You can use this 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.
permissions - A structure that contains the permissions of the dashboard. You can use this for granting permissions with
principal and action information.public CreateDashboardRequest withPermissions(Collection<ResourcePermission> permissions)
A structure that contains the permissions of the dashboard. You can use this for granting permissions with principal and action information.
permissions - A structure that contains the permissions of the dashboard. You can use this for granting permissions with
principal and action information.public void setSourceEntity(DashboardSourceEntity sourceEntity)
Source entity from which the dashboard is created. The souce entity accepts the 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.
sourceEntity - Source entity from which the dashboard is created. The souce entity accepts the 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.
public DashboardSourceEntity getSourceEntity()
Source entity from which the dashboard is created. The souce entity accepts the 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.
If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.
public CreateDashboardRequest withSourceEntity(DashboardSourceEntity sourceEntity)
Source entity from which the dashboard is created. The souce entity accepts the 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.
sourceEntity - Source entity from which the dashboard is created. The souce entity accepts the 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.
public List<Tag> getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
public void setTags(Collection<Tag> tags)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.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.
tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.public CreateDashboardRequest withTags(Collection<Tag> tags)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.public void setVersionDescription(String versionDescription)
A description for the first version of the dashboard being created.
versionDescription - A description for the first version of the dashboard being created.public String getVersionDescription()
A description for the first version of the dashboard being created.
public CreateDashboardRequest withVersionDescription(String versionDescription)
A description for the first version of the dashboard being created.
versionDescription - A description for the first version of the dashboard being created.public void setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating dashboard.
AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or DISABLED.
When This is set to set to DISABLED, QuickSight disables the left filter pane on the published
dashboard, which can be used for AdHoc filtering. Enabled by default.
AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or DISABLED. The
visual option to export data to CSV is disabled when this is set to DISABLED. Enabled by default.
VisibilityState for SheetControlsOption - This can be either COLLAPSED or EXPANDED. The
sheet controls pane is collapsed by default when set to true. Collapsed by default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean
dashboardPublishOptions - Publishing options when creating dashboard.
AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or
DISABLED. When This is set to set to DISABLED, QuickSight disables the left
filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default.
AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or
DISABLED. The visual option to export data to CSV is disabled when this is set to
DISABLED. Enabled by default.
VisibilityState for SheetControlsOption - This can be either COLLAPSED or
EXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by
default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean
public DashboardPublishOptions getDashboardPublishOptions()
Publishing options when creating dashboard.
AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or DISABLED.
When This is set to set to DISABLED, QuickSight disables the left filter pane on the published
dashboard, which can be used for AdHoc filtering. Enabled by default.
AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or DISABLED. The
visual option to export data to CSV is disabled when this is set to DISABLED. Enabled by default.
VisibilityState for SheetControlsOption - This can be either COLLAPSED or EXPANDED. The
sheet controls pane is collapsed by default when set to true. Collapsed by default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean
AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or
DISABLED. When This is set to set to DISABLED, QuickSight disables the left
filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default.
AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or
DISABLED. The visual option to export data to CSV is disabled when this is set to
DISABLED. Enabled by default.
VisibilityState for SheetControlsOption - This can be either COLLAPSED or
EXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by
default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean
public CreateDashboardRequest withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating dashboard.
AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or DISABLED.
When This is set to set to DISABLED, QuickSight disables the left filter pane on the published
dashboard, which can be used for AdHoc filtering. Enabled by default.
AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or DISABLED. The
visual option to export data to CSV is disabled when this is set to DISABLED. Enabled by default.
VisibilityState for SheetControlsOption - This can be either COLLAPSED or EXPANDED. The
sheet controls pane is collapsed by default when set to true. Collapsed by default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean
dashboardPublishOptions - Publishing options when creating dashboard.
AvailabilityStatus for AdHocFilteringOption - This can be either ENABLED or
DISABLED. When This is set to set to DISABLED, QuickSight disables the left
filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default.
AvailabilityStatus for ExportToCSVOption - This can be either ENABLED or
DISABLED. The visual option to export data to CSV is disabled when this is set to
DISABLED. Enabled by default.
VisibilityState for SheetControlsOption - This can be either COLLAPSED or
EXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by
default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean
public String toString()
toString in class ObjectObject.toString()public CreateDashboardRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.