/*
* 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 machinelearning-2014-12-12.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.MachineLearning.Model
{
///
/// Represents the output of a GetBatchPrediction
operation.
///
///
///
/// The content consists of the detailed metadata, the status, and the data file information
/// of a Batch Prediction
.
///
///
public partial class BatchPrediction
{
private string _batchPredictionDataSourceId;
private string _batchPredictionId;
private long? _computeTime;
private DateTime? _createdAt;
private string _createdByIamUser;
private DateTime? _finishedAt;
private string _inputDataLocationS3;
private long? _invalidRecordCount;
private DateTime? _lastUpdatedAt;
private string _message;
private string _mlModelId;
private string _name;
private string _outputUri;
private DateTime? _startedAt;
private EntityStatus _status;
private long? _totalRecordCount;
///
/// Gets and sets the property BatchPredictionDataSourceId.
///
/// The ID of the DataSource
that points to the group of observations to
/// predict.
///
///
[AWSProperty(Min=1, Max=64)]
public string BatchPredictionDataSourceId
{
get { return this._batchPredictionDataSourceId; }
set { this._batchPredictionDataSourceId = value; }
}
// Check to see if BatchPredictionDataSourceId property is set
internal bool IsSetBatchPredictionDataSourceId()
{
return this._batchPredictionDataSourceId != null;
}
///
/// Gets and sets the property BatchPredictionId.
///
/// The ID assigned to the BatchPrediction
at creation. This value should
/// be identical to the value of the BatchPredictionID
in the request.
///
///
[AWSProperty(Min=1, Max=64)]
public string BatchPredictionId
{
get { return this._batchPredictionId; }
set { this._batchPredictionId = value; }
}
// Check to see if BatchPredictionId property is set
internal bool IsSetBatchPredictionId()
{
return this._batchPredictionId != null;
}
///
/// Gets and sets the property ComputeTime.
///
public long ComputeTime
{
get { return this._computeTime.GetValueOrDefault(); }
set { this._computeTime = value; }
}
// Check to see if ComputeTime property is set
internal bool IsSetComputeTime()
{
return this._computeTime.HasValue;
}
///
/// Gets and sets the property CreatedAt.
///
/// The time that the BatchPrediction
was created. The time is expressed
/// in epoch time.
///
///
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 CreatedByIamUser.
///
/// The AWS user account that invoked the BatchPrediction
. The account type
/// can be either an AWS root account or an AWS Identity and Access Management (IAM) user
/// account.
///
///
public string CreatedByIamUser
{
get { return this._createdByIamUser; }
set { this._createdByIamUser = value; }
}
// Check to see if CreatedByIamUser property is set
internal bool IsSetCreatedByIamUser()
{
return this._createdByIamUser != null;
}
///
/// Gets and sets the property FinishedAt.
///
public DateTime FinishedAt
{
get { return this._finishedAt.GetValueOrDefault(); }
set { this._finishedAt = value; }
}
// Check to see if FinishedAt property is set
internal bool IsSetFinishedAt()
{
return this._finishedAt.HasValue;
}
///
/// Gets and sets the property InputDataLocationS3.
///
/// The location of the data file or directory in Amazon Simple Storage Service (Amazon
/// S3).
///
///
[AWSProperty(Max=2048)]
public string InputDataLocationS3
{
get { return this._inputDataLocationS3; }
set { this._inputDataLocationS3 = value; }
}
// Check to see if InputDataLocationS3 property is set
internal bool IsSetInputDataLocationS3()
{
return this._inputDataLocationS3 != null;
}
///
/// Gets and sets the property InvalidRecordCount.
///
public long InvalidRecordCount
{
get { return this._invalidRecordCount.GetValueOrDefault(); }
set { this._invalidRecordCount = value; }
}
// Check to see if InvalidRecordCount property is set
internal bool IsSetInvalidRecordCount()
{
return this._invalidRecordCount.HasValue;
}
///
/// Gets and sets the property LastUpdatedAt.
///
/// The time of the most recent edit to the BatchPrediction
. The time is
/// expressed in epoch time.
///
///
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 Message.
///
/// A description of the most recent details about processing the batch prediction request.
///
///
[AWSProperty(Max=10240)]
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 MLModelId.
///
/// The ID of the MLModel
that generated predictions for the BatchPrediction
/// request.
///
///
[AWSProperty(Min=1, Max=64)]
public string MLModelId
{
get { return this._mlModelId; }
set { this._mlModelId = value; }
}
// Check to see if MLModelId property is set
internal bool IsSetMLModelId()
{
return this._mlModelId != null;
}
///
/// Gets and sets the property Name.
///
/// A user-supplied name or description of the BatchPrediction
.
///
///
[AWSProperty(Max=1024)]
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 OutputUri.
///
/// The location of an Amazon S3 bucket or directory to receive the operation results.
/// The following substrings are not allowed in the s3 key
portion of the
/// outputURI
field: ':', '//', '/./', '/../'.
///
///
[AWSProperty(Max=2048)]
public string OutputUri
{
get { return this._outputUri; }
set { this._outputUri = value; }
}
// Check to see if OutputUri property is set
internal bool IsSetOutputUri()
{
return this._outputUri != null;
}
///
/// Gets and sets the property StartedAt.
///
public DateTime StartedAt
{
get { return this._startedAt.GetValueOrDefault(); }
set { this._startedAt = value; }
}
// Check to see if StartedAt property is set
internal bool IsSetStartedAt()
{
return this._startedAt.HasValue;
}
///
/// Gets and sets the property Status.
///
/// The status of the BatchPrediction
. This element can have one of the following
/// values:
///
/// -
///
///
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to
/// generate predictions for a batch of observations.
///
/// -
///
///
INPROGRESS
- The process is underway.
///
/// -
///
///
FAILED
- The request to perform a batch prediction did not run to completion.
/// It is not usable.
///
/// -
///
///
COMPLETED
- The batch prediction process completed successfully.
///
/// -
///
///
DELETED
- The BatchPrediction
is marked as deleted. It
/// is not usable.
///
///
///
public EntityStatus 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 TotalRecordCount.
///
public long TotalRecordCount
{
get { return this._totalRecordCount.GetValueOrDefault(); }
set { this._totalRecordCount = value; }
}
// Check to see if TotalRecordCount property is set
internal bool IsSetTotalRecordCount()
{
return this._totalRecordCount.HasValue;
}
}
}