/*
* 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 personalize-2018-05-22.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.Personalize.Model
{
///
/// Container for the parameters to the CreateBatchInferenceJob operation.
/// Creates a batch inference job. The operation can handle up to 50 million records and
/// the input file must be in JSON format. For more information, see Creating
/// a batch inference job.
///
public partial class CreateBatchInferenceJobRequest : AmazonPersonalizeRequest
{
private BatchInferenceJobConfig _batchInferenceJobConfig;
private string _filterArn;
private BatchInferenceJobInput _jobInput;
private string _jobName;
private BatchInferenceJobOutput _jobOutput;
private int? _numResults;
private string _roleArn;
private string _solutionVersionArn;
private List _tags = new List();
///
/// Gets and sets the property BatchInferenceJobConfig.
///
/// The configuration details of a batch inference job.
///
///
public BatchInferenceJobConfig BatchInferenceJobConfig
{
get { return this._batchInferenceJobConfig; }
set { this._batchInferenceJobConfig = value; }
}
// Check to see if BatchInferenceJobConfig property is set
internal bool IsSetBatchInferenceJobConfig()
{
return this._batchInferenceJobConfig != null;
}
///
/// Gets and sets the property FilterArn.
///
/// The ARN of the filter to apply to the batch inference job. For more information on
/// using filters, see Filtering
/// batch recommendations.
///
///
[AWSProperty(Max=256)]
public string FilterArn
{
get { return this._filterArn; }
set { this._filterArn = value; }
}
// Check to see if FilterArn property is set
internal bool IsSetFilterArn()
{
return this._filterArn != null;
}
///
/// Gets and sets the property JobInput.
///
/// The Amazon S3 path that leads to the input file to base your recommendations on. The
/// input material must be in JSON format.
///
///
[AWSProperty(Required=true)]
public BatchInferenceJobInput JobInput
{
get { return this._jobInput; }
set { this._jobInput = value; }
}
// Check to see if JobInput property is set
internal bool IsSetJobInput()
{
return this._jobInput != null;
}
///
/// Gets and sets the property JobName.
///
/// The name of the batch inference job to create.
///
///
[AWSProperty(Required=true, Min=1, Max=63)]
public string JobName
{
get { return this._jobName; }
set { this._jobName = value; }
}
// Check to see if JobName property is set
internal bool IsSetJobName()
{
return this._jobName != null;
}
///
/// Gets and sets the property JobOutput.
///
/// The path to the Amazon S3 bucket where the job's output will be stored.
///
///
[AWSProperty(Required=true)]
public BatchInferenceJobOutput JobOutput
{
get { return this._jobOutput; }
set { this._jobOutput = value; }
}
// Check to see if JobOutput property is set
internal bool IsSetJobOutput()
{
return this._jobOutput != null;
}
///
/// Gets and sets the property NumResults.
///
/// The number of recommendations to retrieve.
///
///
public int NumResults
{
get { return this._numResults.GetValueOrDefault(); }
set { this._numResults = value; }
}
// Check to see if NumResults property is set
internal bool IsSetNumResults()
{
return this._numResults.HasValue;
}
///
/// Gets and sets the property RoleArn.
///
/// The ARN of the Amazon Identity and Access Management role that has permissions to
/// read and write to your input and output Amazon S3 buckets respectively.
///
///
[AWSProperty(Required=true, Max=256)]
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 SolutionVersionArn.
///
/// The Amazon Resource Name (ARN) of the solution version that will be used to generate
/// the batch inference recommendations.
///
///
[AWSProperty(Required=true, Max=256)]
public string SolutionVersionArn
{
get { return this._solutionVersionArn; }
set { this._solutionVersionArn = value; }
}
// Check to see if SolutionVersionArn property is set
internal bool IsSetSolutionVersionArn()
{
return this._solutionVersionArn != null;
}
///
/// Gets and sets the property Tags.
///
/// A list of tags
/// to apply to the batch inference job.
///
///
[AWSProperty(Min=0, Max=200)]
public List 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;
}
}
}