@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateDashboardRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
UpdateDashboardRequest() |
| Modifier and Type | Method and Description |
|---|---|
UpdateDashboardRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAwsAccountId()
AWS account ID that contains the dashboard you are updating.
|
String |
getDashboardId()
The ID for the dashboard.
|
DashboardPublishOptions |
getDashboardPublishOptions()
Publishing options when creating a dashboard.
|
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)
AWS account ID that contains the dashboard you are updating.
|
void |
setDashboardId(String dashboardId)
The ID for the dashboard.
|
void |
setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating a dashboard.
|
void |
setName(String name)
The display name of the dashboard.
|
void |
setParameters(Parameters parameters)
A structure that contains the parameters of the dashboard.
|
void |
setSourceEntity(DashboardSourceEntity sourceEntity)
The 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)
AWS account ID that contains the dashboard you are updating.
|
UpdateDashboardRequest |
withDashboardId(String dashboardId)
The ID for the dashboard.
|
UpdateDashboardRequest |
withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating a dashboard.
|
UpdateDashboardRequest |
withName(String name)
The display name of the dashboard.
|
UpdateDashboardRequest |
withParameters(Parameters parameters)
A structure that contains the parameters of the dashboard.
|
UpdateDashboardRequest |
withSourceEntity(DashboardSourceEntity sourceEntity)
The template or analysis from which the dashboard is created.
|
UpdateDashboardRequest |
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 that contains the dashboard you are updating.
awsAccountId - AWS account ID that contains the dashboard you are updating.public String getAwsAccountId()
AWS account ID that contains the dashboard you are updating.
public UpdateDashboardRequest withAwsAccountId(String awsAccountId)
AWS account ID that contains the dashboard you are updating.
awsAccountId - AWS account ID that contains the dashboard you are updating.public void setDashboardId(String dashboardId)
The ID for the dashboard.
dashboardId - The ID for the dashboard.public String getDashboardId()
The ID for the dashboard.
public UpdateDashboardRequest withDashboardId(String dashboardId)
The ID for the dashboard.
dashboardId - The ID for the dashboard.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 UpdateDashboardRequest withName(String name)
The display name of the dashboard.
name - The display name of the dashboard.public void setSourceEntity(DashboardSourceEntity sourceEntity)
The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the 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.
sourceEntity - The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the 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.public DashboardSourceEntity getSourceEntity()
The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the 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.
public UpdateDashboardRequest withSourceEntity(DashboardSourceEntity sourceEntity)
The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the 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.
sourceEntity - The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the 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.public void setParameters(Parameters parameters)
A structure that contains the parameters of the dashboard.
parameters - A structure that contains the parameters of the dashboard.public Parameters getParameters()
A structure that contains the parameters of the dashboard.
public UpdateDashboardRequest withParameters(Parameters parameters)
A structure that contains the parameters of the dashboard.
parameters - A structure that contains the parameters of 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 UpdateDashboardRequest 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 a 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.
dashboardPublishOptions - Publishing options when creating a 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.
public DashboardPublishOptions getDashboardPublishOptions()
Publishing options when creating a 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.
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.
public UpdateDashboardRequest withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)
Publishing options when creating a 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.
dashboardPublishOptions - Publishing options when creating a 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.
public String toString()
toString in class ObjectObject.toString()public UpdateDashboardRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.