/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the quicksight-2018-04-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.QuickSight.Model
{
///
/// This is the response object from the DescribeDashboardDefinition operation.
///
public partial class DescribeDashboardDefinitionResponse : AmazonWebServiceResponse
{
private string _dashboardId;
private DashboardPublishOptions _dashboardPublishOptions;
private DashboardVersionDefinition _definition;
private List _errors = new List();
private string _name;
private string _requestId;
private ResourceStatus _resourceStatus;
private int? _status;
private string _themeArn;
///
/// Gets and sets the property DashboardId.
///
/// The ID of the dashboard described.
///
///
[AWSProperty(Min=1, Max=512)]
public string DashboardId
{
get { return this._dashboardId; }
set { this._dashboardId = value; }
}
// Check to see if DashboardId property is set
internal bool IsSetDashboardId()
{
return this._dashboardId != null;
}
///
/// Gets and sets the property DashboardPublishOptions.
///
/// Options for publishing the dashboard:
///
/// -
///
///
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.
///
///
///
public DashboardPublishOptions DashboardPublishOptions
{
get { return this._dashboardPublishOptions; }
set { this._dashboardPublishOptions = value; }
}
// Check to see if DashboardPublishOptions property is set
internal bool IsSetDashboardPublishOptions()
{
return this._dashboardPublishOptions != null;
}
///
/// Gets and sets the property Definition.
///
/// The definition of a dashboard.
///
///
///
/// A definition is the data model of all features in a Dashboard, Template, or Analysis.
///
///
public DashboardVersionDefinition Definition
{
get { return this._definition; }
set { this._definition = value; }
}
// Check to see if Definition property is set
internal bool IsSetDefinition()
{
return this._definition != null;
}
///
/// Gets and sets the property Errors.
///
/// Errors associated with this dashboard version.
///
///
[AWSProperty(Min=1)]
public List Errors
{
get { return this._errors; }
set { this._errors = value; }
}
// Check to see if Errors property is set
internal bool IsSetErrors()
{
return this._errors != null && this._errors.Count > 0;
}
///
/// Gets and sets the property Name.
///
/// The display name of the dashboard.
///
///
[AWSProperty(Min=1, Max=2048)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property RequestId.
///
/// The Amazon Web Services request ID for this operation.
///
///
public string RequestId
{
get { return this._requestId; }
set { this._requestId = value; }
}
// Check to see if RequestId property is set
internal bool IsSetRequestId()
{
return this._requestId != null;
}
///
/// Gets and sets the property ResourceStatus.
///
/// Status associated with the dashboard version.
///
/// -
///
///
CREATION_IN_PROGRESS
///
/// -
///
///
CREATION_SUCCESSFUL
///
/// -
///
///
CREATION_FAILED
///
/// -
///
///
UPDATE_IN_PROGRESS
///
/// -
///
///
UPDATE_SUCCESSFUL
///
/// -
///
///
UPDATE_FAILED
///
/// -
///
///
DELETED
///
///
///
public ResourceStatus ResourceStatus
{
get { return this._resourceStatus; }
set { this._resourceStatus = value; }
}
// Check to see if ResourceStatus property is set
internal bool IsSetResourceStatus()
{
return this._resourceStatus != null;
}
///
/// Gets and sets the property Status.
///
/// The HTTP status of the request.
///
///
public int Status
{
get { return this._status.GetValueOrDefault(); }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status.HasValue;
}
///
/// Gets and sets the property ThemeArn.
///
/// The ARN of the theme of the dashboard.
///
///
public string ThemeArn
{
get { return this._themeArn; }
set { this._themeArn = value; }
}
// Check to see if ThemeArn property is set
internal bool IsSetThemeArn()
{
return this._themeArn != null;
}
}
}