/*
* 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 forecast-2018-06-26.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.ForecastService.Model
{
///
/// This is the response object from the DescribeExplainability operation.
///
public partial class DescribeExplainabilityResponse : AmazonWebServiceResponse
{
private DateTime? _creationTime;
private DataSource _dataSource;
private bool? _enableVisualization;
private string _endDateTime;
private long? _estimatedTimeRemainingInMinutes;
private string _explainabilityArn;
private ExplainabilityConfig _explainabilityConfig;
private string _explainabilityName;
private DateTime? _lastModificationTime;
private string _message;
private string _resourceArn;
private Schema _schema;
private string _startDateTime;
private string _status;
///
/// Gets and sets the property CreationTime.
///
/// When the Explainability resource was created.
///
///
public DateTime CreationTime
{
get { return this._creationTime.GetValueOrDefault(); }
set { this._creationTime = value; }
}
// Check to see if CreationTime property is set
internal bool IsSetCreationTime()
{
return this._creationTime.HasValue;
}
///
/// Gets and sets the property DataSource.
///
public DataSource DataSource
{
get { return this._dataSource; }
set { this._dataSource = value; }
}
// Check to see if DataSource property is set
internal bool IsSetDataSource()
{
return this._dataSource != null;
}
///
/// Gets and sets the property EnableVisualization.
///
/// Whether the visualization was enabled for the Explainability resource.
///
///
public bool EnableVisualization
{
get { return this._enableVisualization.GetValueOrDefault(); }
set { this._enableVisualization = value; }
}
// Check to see if EnableVisualization property is set
internal bool IsSetEnableVisualization()
{
return this._enableVisualization.HasValue;
}
///
/// Gets and sets the property EndDateTime.
///
/// If TimePointGranularity
is set to SPECIFIC
, the last time
/// point in the Explainability.
///
///
[AWSProperty(Max=19)]
public string EndDateTime
{
get { return this._endDateTime; }
set { this._endDateTime = value; }
}
// Check to see if EndDateTime property is set
internal bool IsSetEndDateTime()
{
return this._endDateTime != null;
}
///
/// Gets and sets the property EstimatedTimeRemainingInMinutes.
///
/// The estimated time remaining in minutes for the CreateExplainability job to
/// complete.
///
///
public long EstimatedTimeRemainingInMinutes
{
get { return this._estimatedTimeRemainingInMinutes.GetValueOrDefault(); }
set { this._estimatedTimeRemainingInMinutes = value; }
}
// Check to see if EstimatedTimeRemainingInMinutes property is set
internal bool IsSetEstimatedTimeRemainingInMinutes()
{
return this._estimatedTimeRemainingInMinutes.HasValue;
}
///
/// Gets and sets the property ExplainabilityArn.
///
/// The Amazon Resource Name (ARN) of the Explainability.
///
///
[AWSProperty(Max=256)]
public string ExplainabilityArn
{
get { return this._explainabilityArn; }
set { this._explainabilityArn = value; }
}
// Check to see if ExplainabilityArn property is set
internal bool IsSetExplainabilityArn()
{
return this._explainabilityArn != null;
}
///
/// Gets and sets the property ExplainabilityConfig.
///
/// The configuration settings that define the granularity of time series and time points
/// for the Explainability.
///
///
public ExplainabilityConfig ExplainabilityConfig
{
get { return this._explainabilityConfig; }
set { this._explainabilityConfig = value; }
}
// Check to see if ExplainabilityConfig property is set
internal bool IsSetExplainabilityConfig()
{
return this._explainabilityConfig != null;
}
///
/// Gets and sets the property ExplainabilityName.
///
/// The name of the Explainability.
///
///
[AWSProperty(Min=1, Max=63)]
public string ExplainabilityName
{
get { return this._explainabilityName; }
set { this._explainabilityName = value; }
}
// Check to see if ExplainabilityName property is set
internal bool IsSetExplainabilityName()
{
return this._explainabilityName != null;
}
///
/// Gets and sets the property LastModificationTime.
///
/// The last time the resource was modified. The timestamp depends on the status of the
/// job:
///
/// -
///
///
CREATE_PENDING
- The CreationTime
.
///
/// -
///
///
CREATE_IN_PROGRESS
- The current timestamp.
///
/// -
///
///
CREATE_STOPPING
- The current timestamp.
///
/// -
///
///
CREATE_STOPPED
- When the job stopped.
///
/// -
///
///
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
///
///
///
public DateTime LastModificationTime
{
get { return this._lastModificationTime.GetValueOrDefault(); }
set { this._lastModificationTime = value; }
}
// Check to see if LastModificationTime property is set
internal bool IsSetLastModificationTime()
{
return this._lastModificationTime.HasValue;
}
///
/// Gets and sets the property Message.
///
/// If an error occurred, a message about the error.
///
///
public string Message
{
get { return this._message; }
set { this._message = value; }
}
// Check to see if Message property is set
internal bool IsSetMessage()
{
return this._message != null;
}
///
/// Gets and sets the property ResourceArn.
///
/// The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability
/// resource.
///
///
[AWSProperty(Max=256)]
public string ResourceArn
{
get { return this._resourceArn; }
set { this._resourceArn = value; }
}
// Check to see if ResourceArn property is set
internal bool IsSetResourceArn()
{
return this._resourceArn != null;
}
///
/// Gets and sets the property Schema.
///
public Schema Schema
{
get { return this._schema; }
set { this._schema = value; }
}
// Check to see if Schema property is set
internal bool IsSetSchema()
{
return this._schema != null;
}
///
/// Gets and sets the property StartDateTime.
///
/// If TimePointGranularity
is set to SPECIFIC
, the first time
/// point in the Explainability.
///
///
[AWSProperty(Max=19)]
public string StartDateTime
{
get { return this._startDateTime; }
set { this._startDateTime = value; }
}
// Check to see if StartDateTime property is set
internal bool IsSetStartDateTime()
{
return this._startDateTime != null;
}
///
/// Gets and sets the property Status.
///
/// The status of the Explainability resource. States include:
///
/// -
///
///
ACTIVE
///
/// -
///
///
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
///
///
/// -
///
///
CREATE_STOPPING
, CREATE_STOPPED
///
/// -
///
///
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
///
///
///
///
[AWSProperty(Max=256)]
public string Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
}
}