/*
* 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 DescribeDashboardSnapshotJob operation.
///
public partial class DescribeDashboardSnapshotJobResponse : AmazonWebServiceResponse
{
private string _arn;
private string _awsAccountId;
private DateTime? _createdTime;
private string _dashboardId;
private SnapshotJobStatus _jobStatus;
private DateTime? _lastUpdatedTime;
private string _requestId;
private SnapshotConfiguration _snapshotConfiguration;
private string _snapshotJobId;
private int? _status;
private SnapshotUserConfigurationRedacted _userConfiguration;
///
/// Gets and sets the property Arn.
///
/// The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when
/// you start a new job with a StartDashboardSnapshotJob
API call.
///
///
public string Arn
{
get { return this._arn; }
set { this._arn = value; }
}
// Check to see if Arn property is set
internal bool IsSetArn()
{
return this._arn != null;
}
///
/// Gets and sets the property AwsAccountId.
///
/// The ID of the Amazon Web Services account that the dashboard snapshot job is executed
/// in.
///
///
[AWSProperty(Min=12, Max=12)]
public string AwsAccountId
{
get { return this._awsAccountId; }
set { this._awsAccountId = value; }
}
// Check to see if AwsAccountId property is set
internal bool IsSetAwsAccountId()
{
return this._awsAccountId != null;
}
///
/// Gets and sets the property CreatedTime.
///
/// The time that the snapshot job was created.
///
///
public DateTime CreatedTime
{
get { return this._createdTime.GetValueOrDefault(); }
set { this._createdTime = value; }
}
// Check to see if CreatedTime property is set
internal bool IsSetCreatedTime()
{
return this._createdTime.HasValue;
}
///
/// Gets and sets the property DashboardId.
///
/// The ID of the dashboard that you have started a snapshot job for.
///
///
[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 JobStatus.
///
/// Indicates the status of a job. The status updates as the job executes. This shows
/// one of the following values.
///
/// -
///
///
COMPLETED
- The job was completed successfully.
///
/// -
///
///
FAILED
- The job failed to execute.
///
/// -
///
///
QUEUED
- The job is queued and hasn't started yet.
///
/// -
///
///
RUNNING
- The job is still running.
///
///
///
public SnapshotJobStatus JobStatus
{
get { return this._jobStatus; }
set { this._jobStatus = value; }
}
// Check to see if JobStatus property is set
internal bool IsSetJobStatus()
{
return this._jobStatus != null;
}
///
/// Gets and sets the property LastUpdatedTime.
///
/// The time that the snapshot job status was last updated.
///
///
public DateTime LastUpdatedTime
{
get { return this._lastUpdatedTime.GetValueOrDefault(); }
set { this._lastUpdatedTime = value; }
}
// Check to see if LastUpdatedTime property is set
internal bool IsSetLastUpdatedTime()
{
return this._lastUpdatedTime.HasValue;
}
///
/// 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 SnapshotConfiguration.
///
/// The snapshot configuration of the job. This information is provided when you make
/// a StartDashboardSnapshotJob
API call.
///
///
public SnapshotConfiguration SnapshotConfiguration
{
get { return this._snapshotConfiguration; }
set { this._snapshotConfiguration = value; }
}
// Check to see if SnapshotConfiguration property is set
internal bool IsSetSnapshotConfiguration()
{
return this._snapshotConfiguration != null;
}
///
/// Gets and sets the property SnapshotJobId.
///
/// The ID of the job to be described. The job ID is set when you start a new job with
/// a StartDashboardSnapshotJob
API call.
///
///
[AWSProperty(Min=1, Max=512)]
public string SnapshotJobId
{
get { return this._snapshotJobId; }
set { this._snapshotJobId = value; }
}
// Check to see if SnapshotJobId property is set
internal bool IsSetSnapshotJobId()
{
return this._snapshotJobId != 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 UserConfiguration.
///
/// The user configuration for the snapshot job. This information is provided when you
/// make a StartDashboardSnapshotJob
API call.
///
///
public SnapshotUserConfigurationRedacted UserConfiguration
{
get { return this._userConfiguration; }
set { this._userConfiguration = value; }
}
// Check to see if UserConfiguration property is set
internal bool IsSetUserConfiguration()
{
return this._userConfiguration != null;
}
}
}