/*
* 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 simspaceweaver-2022-10-28.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.SimSpaceWeaver.Model
{
///
/// This is the response object from the DescribeSimulation operation.
///
public partial class DescribeSimulationResponse : AmazonWebServiceResponse
{
private string _arn;
private DateTime? _creationTime;
private string _description;
private string _executionId;
private LiveSimulationState _liveSimulationState;
private LoggingConfiguration _loggingConfiguration;
private string _maximumDuration;
private string _name;
private string _roleArn;
private string _schemaError;
private S3Location _schemaS3Location;
private S3Location _snapshotS3Location;
private string _startError;
private SimulationStatus _status;
private SimulationTargetStatus _targetStatus;
///
/// Gets and sets the property Arn.
///
/// The Amazon Resource Name (ARN) of the simulation. For more information about ARNs,
/// see Amazon
/// Resource Names (ARNs) in the Amazon Web Services General Reference.
///
///
[AWSProperty(Min=0, Max=1600)]
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 CreationTime.
///
/// The time when the simulation was created, expressed as the number of seconds and milliseconds
/// in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
///
///
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 Description.
///
/// The description of the simulation.
///
///
[AWSProperty(Min=0, Max=500)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property ExecutionId.
///
/// A universally unique identifier (UUID) for this simulation.
///
///
[AWSProperty(Min=36)]
public string ExecutionId
{
get { return this._executionId; }
set { this._executionId = value; }
}
// Check to see if ExecutionId property is set
internal bool IsSetExecutionId()
{
return this._executionId != null;
}
///
/// Gets and sets the property LiveSimulationState.
///
/// A collection of additional state information, such as domain and clock configuration.
///
///
public LiveSimulationState LiveSimulationState
{
get { return this._liveSimulationState; }
set { this._liveSimulationState = value; }
}
// Check to see if LiveSimulationState property is set
internal bool IsSetLiveSimulationState()
{
return this._liveSimulationState != null;
}
///
/// Gets and sets the property LoggingConfiguration.
///
/// Settings that control how SimSpace Weaver handles your simulation log data.
///
///
public LoggingConfiguration LoggingConfiguration
{
get { return this._loggingConfiguration; }
set { this._loggingConfiguration = value; }
}
// Check to see if LoggingConfiguration property is set
internal bool IsSetLoggingConfiguration()
{
return this._loggingConfiguration != null;
}
///
/// Gets and sets the property MaximumDuration.
///
/// The maximum running time of the simulation, specified as a number of minutes (m or
/// M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit.
/// The maximum value is 14D
, or its equivalent in the other units. The default
/// value is 14D
. A value equivalent to 0
makes the simulation
/// immediately transition to Stopping
as soon as it reaches Started
.
///
///
[AWSProperty(Min=2, Max=6)]
public string MaximumDuration
{
get { return this._maximumDuration; }
set { this._maximumDuration = value; }
}
// Check to see if MaximumDuration property is set
internal bool IsSetMaximumDuration()
{
return this._maximumDuration != null;
}
///
/// Gets and sets the property Name.
///
/// The name of the simulation.
///
///
[AWSProperty(Min=1, Max=64)]
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 RoleArn.
///
/// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that
/// the simulation assumes to perform actions. For more information about ARNs, see Amazon
/// Resource Names (ARNs) in the Amazon Web Services General Reference. For
/// more information about IAM roles, see IAM
/// roles in the Identity and Access Management User Guide.
///
///
[AWSProperty(Min=0, Max=1600)]
public string RoleArn
{
get { return this._roleArn; }
set { this._roleArn = value; }
}
// Check to see if RoleArn property is set
internal bool IsSetRoleArn()
{
return this._roleArn != null;
}
///
/// Gets and sets the property SchemaError.
///
/// An error message that SimSpace Weaver returns only if there is a problem with the
/// simulation schema.
///
///
[Obsolete("SchemaError is no longer used, check StartError instead.")]
public string SchemaError
{
get { return this._schemaError; }
set { this._schemaError = value; }
}
// Check to see if SchemaError property is set
internal bool IsSetSchemaError()
{
return this._schemaError != null;
}
///
/// Gets and sets the property SchemaS3Location.
///
/// The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
/// For more information about Amazon S3, see the
/// Amazon Simple Storage Service User Guide .
///
///
public S3Location SchemaS3Location
{
get { return this._schemaS3Location; }
set { this._schemaS3Location = value; }
}
// Check to see if SchemaS3Location property is set
internal bool IsSetSchemaS3Location()
{
return this._schemaS3Location != null;
}
///
/// Gets and sets the property SnapshotS3Location.
///
public S3Location SnapshotS3Location
{
get { return this._snapshotS3Location; }
set { this._snapshotS3Location = value; }
}
// Check to see if SnapshotS3Location property is set
internal bool IsSetSnapshotS3Location()
{
return this._snapshotS3Location != null;
}
///
/// Gets and sets the property StartError.
///
/// An error message that SimSpace Weaver returns only if a problem occurs when the simulation
/// is in the STARTING
state.
///
///
public string StartError
{
get { return this._startError; }
set { this._startError = value; }
}
// Check to see if StartError property is set
internal bool IsSetStartError()
{
return this._startError != null;
}
///
/// Gets and sets the property Status.
///
/// The current lifecycle state of the simulation.
///
///
public SimulationStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property TargetStatus.
///
/// The desired lifecycle state of the simulation.
///
///
public SimulationTargetStatus TargetStatus
{
get { return this._targetStatus; }
set { this._targetStatus = value; }
}
// Check to see if TargetStatus property is set
internal bool IsSetTargetStatus()
{
return this._targetStatus != null;
}
}
}