/*
* 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 robomaker-2018-06-29.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.RoboMaker.Model
{
///
/// This is the response object from the DescribeSimulationJobBatch operation.
///
public partial class DescribeSimulationJobBatchResponse : AmazonWebServiceResponse
{
private string _arn;
private BatchPolicy _batchPolicy;
private string _clientRequestToken;
private DateTime? _createdAt;
private List _createdRequests = new List();
private List _failedRequests = new List();
private SimulationJobBatchErrorCode _failureCode;
private string _failureReason;
private DateTime? _lastUpdatedAt;
private List _pendingRequests = new List();
private SimulationJobBatchStatus _status;
private Dictionary _tags = new Dictionary();
///
/// Gets and sets the property Arn.
///
/// The Amazon Resource Name (ARN) of the batch.
///
///
[AWSProperty(Min=1, Max=1224)]
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 BatchPolicy.
///
/// The batch policy.
///
///
public BatchPolicy BatchPolicy
{
get { return this._batchPolicy; }
set { this._batchPolicy = value; }
}
// Check to see if BatchPolicy property is set
internal bool IsSetBatchPolicy()
{
return this._batchPolicy != null;
}
///
/// Gets and sets the property ClientRequestToken.
///
/// Unique, case-sensitive identifier that you provide to ensure the idempotency of the
/// request.
///
///
[AWSProperty(Min=1, Max=64)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
///
/// Gets and sets the property CreatedAt.
///
/// The time, in milliseconds since the epoch, when the simulation job batch was created.
///
///
public DateTime CreatedAt
{
get { return this._createdAt.GetValueOrDefault(); }
set { this._createdAt = value; }
}
// Check to see if CreatedAt property is set
internal bool IsSetCreatedAt()
{
return this._createdAt.HasValue;
}
///
/// Gets and sets the property CreatedRequests.
///
/// A list of created simulation job summaries.
///
///
[AWSProperty(Min=0, Max=100)]
public List CreatedRequests
{
get { return this._createdRequests; }
set { this._createdRequests = value; }
}
// Check to see if CreatedRequests property is set
internal bool IsSetCreatedRequests()
{
return this._createdRequests != null && this._createdRequests.Count > 0;
}
///
/// Gets and sets the property FailedRequests.
///
/// A list of failed create simulation job requests. The request failed to be created
/// into a simulation job. Failed requests do not have a simulation job ID.
///
///
public List FailedRequests
{
get { return this._failedRequests; }
set { this._failedRequests = value; }
}
// Check to see if FailedRequests property is set
internal bool IsSetFailedRequests()
{
return this._failedRequests != null && this._failedRequests.Count > 0;
}
///
/// Gets and sets the property FailureCode.
///
/// The failure code of the simulation job batch.
///
///
public SimulationJobBatchErrorCode FailureCode
{
get { return this._failureCode; }
set { this._failureCode = value; }
}
// Check to see if FailureCode property is set
internal bool IsSetFailureCode()
{
return this._failureCode != null;
}
///
/// Gets and sets the property FailureReason.
///
/// The reason the simulation job batch failed.
///
///
[AWSProperty(Min=0, Max=1024)]
public string FailureReason
{
get { return this._failureReason; }
set { this._failureReason = value; }
}
// Check to see if FailureReason property is set
internal bool IsSetFailureReason()
{
return this._failureReason != null;
}
///
/// Gets and sets the property LastUpdatedAt.
///
/// The time, in milliseconds since the epoch, when the simulation job batch was last
/// updated.
///
///
public DateTime LastUpdatedAt
{
get { return this._lastUpdatedAt.GetValueOrDefault(); }
set { this._lastUpdatedAt = value; }
}
// Check to see if LastUpdatedAt property is set
internal bool IsSetLastUpdatedAt()
{
return this._lastUpdatedAt.HasValue;
}
///
/// Gets and sets the property PendingRequests.
///
/// A list of pending simulation job requests. These requests have not yet been created
/// into simulation jobs.
///
///
[AWSProperty(Min=1, Max=1000)]
public List PendingRequests
{
get { return this._pendingRequests; }
set { this._pendingRequests = value; }
}
// Check to see if PendingRequests property is set
internal bool IsSetPendingRequests()
{
return this._pendingRequests != null && this._pendingRequests.Count > 0;
}
///
/// Gets and sets the property Status.
///
/// The status of the batch.
///
/// - Pending
-
///
/// The simulation job batch request is pending.
///
///
- InProgress
-
///
/// The simulation job batch is in progress.
///
///
- Failed
-
///
/// The simulation job batch failed. One or more simulation job requests could not be
/// completed due to an internal failure (like
InternalServiceError
). See
/// failureCode
and failureReason
for more information.
///
/// - Completed
-
///
/// The simulation batch job completed. A batch is complete when (1) there are no pending
/// simulation job requests in the batch and none of the failed simulation job requests
/// are due to
InternalServiceError
and (2) when all created simulation jobs
/// have reached a terminal state (for example, Completed
or Failed
).
///
///
/// - Canceled
-
///
/// The simulation batch job was cancelled.
///
///
- Canceling
-
///
/// The simulation batch job is being cancelled.
///
///
- Completing
-
///
/// The simulation batch job is completing.
///
///
- TimingOut
-
///
/// The simulation job batch is timing out.
///
///
///
/// If a batch timing out, and there are pending requests that were failing due to an
/// internal failure (like
InternalServiceError
), the batch status will be
/// Failed
. If there are no such failing request, the batch status will be
/// TimedOut
.
///
/// - TimedOut
-
///
/// The simulation batch job timed out.
///
///
///
public SimulationJobBatchStatus 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 Tags.
///
/// A map that contains tag keys and tag values that are attached to the simulation job
/// batch.
///
///
[AWSProperty(Min=0, Max=50)]
public Dictionary Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
}