/*
* 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 braket-2019-09-01.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.Braket.Model
{
///
/// Container for the parameters to the CreateJob operation.
/// Creates an Amazon Braket job.
///
public partial class CreateJobRequest : AmazonBraketRequest
{
private AlgorithmSpecification _algorithmSpecification;
private JobCheckpointConfig _checkpointConfig;
private string _clientToken;
private DeviceConfig _deviceConfig;
private Dictionary _hyperParameters = new Dictionary();
private List _inputDataConfig = new List();
private InstanceConfig _instanceConfig;
private string _jobName;
private JobOutputDataConfig _outputDataConfig;
private string _roleArn;
private JobStoppingCondition _stoppingCondition;
private Dictionary _tags = new Dictionary();
///
/// Gets and sets the property AlgorithmSpecification.
///
/// Definition of the Amazon Braket job to be created. Specifies the container image the
/// job uses and information about the Python scripts used for entry and training.
///
///
[AWSProperty(Required=true)]
public AlgorithmSpecification AlgorithmSpecification
{
get { return this._algorithmSpecification; }
set { this._algorithmSpecification = value; }
}
// Check to see if AlgorithmSpecification property is set
internal bool IsSetAlgorithmSpecification()
{
return this._algorithmSpecification != null;
}
///
/// Gets and sets the property CheckpointConfig.
///
/// Information about the output locations for job checkpoint data.
///
///
public JobCheckpointConfig CheckpointConfig
{
get { return this._checkpointConfig; }
set { this._checkpointConfig = value; }
}
// Check to see if CheckpointConfig property is set
internal bool IsSetCheckpointConfig()
{
return this._checkpointConfig != null;
}
///
/// Gets and sets the property ClientToken.
///
/// A unique token that guarantees that the call to this API is idempotent.
///
///
[AWSProperty(Min=1, Max=64)]
public string ClientToken
{
get { return this._clientToken; }
set { this._clientToken = value; }
}
// Check to see if ClientToken property is set
internal bool IsSetClientToken()
{
return this._clientToken != null;
}
///
/// Gets and sets the property DeviceConfig.
///
/// The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
///
///
[AWSProperty(Required=true)]
public DeviceConfig DeviceConfig
{
get { return this._deviceConfig; }
set { this._deviceConfig = value; }
}
// Check to see if DeviceConfig property is set
internal bool IsSetDeviceConfig()
{
return this._deviceConfig != null;
}
///
/// Gets and sets the property HyperParameters.
///
/// Algorithm-specific parameters used by an Amazon Braket job that influence the quality
/// of the training job. The values are set with a string of JSON key:value pairs, where
/// the key is the name of the hyperparameter and the value is the value of th hyperparameter.
///
///
[AWSProperty(Min=0, Max=100)]
public Dictionary HyperParameters
{
get { return this._hyperParameters; }
set { this._hyperParameters = value; }
}
// Check to see if HyperParameters property is set
internal bool IsSetHyperParameters()
{
return this._hyperParameters != null && this._hyperParameters.Count > 0;
}
///
/// Gets and sets the property InputDataConfig.
///
/// A list of parameters that specify the name and type of input data and where it is
/// located.
///
///
[AWSProperty(Min=0, Max=20)]
public List InputDataConfig
{
get { return this._inputDataConfig; }
set { this._inputDataConfig = value; }
}
// Check to see if InputDataConfig property is set
internal bool IsSetInputDataConfig()
{
return this._inputDataConfig != null && this._inputDataConfig.Count > 0;
}
///
/// Gets and sets the property InstanceConfig.
///
/// Configuration of the resource instances to use while running the hybrid job on Amazon
/// Braket.
///
///
[AWSProperty(Required=true)]
public InstanceConfig InstanceConfig
{
get { return this._instanceConfig; }
set { this._instanceConfig = value; }
}
// Check to see if InstanceConfig property is set
internal bool IsSetInstanceConfig()
{
return this._instanceConfig != null;
}
///
/// Gets and sets the property JobName.
///
/// The name of the Amazon Braket job.
///
///
[AWSProperty(Required=true, Min=1, Max=50)]
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 OutputDataConfig.
///
/// The path to the S3 location where you want to store job artifacts and the encryption
/// key used to store them.
///
///
[AWSProperty(Required=true)]
public JobOutputDataConfig OutputDataConfig
{
get { return this._outputDataConfig; }
set { this._outputDataConfig = value; }
}
// Check to see if OutputDataConfig property is set
internal bool IsSetOutputDataConfig()
{
return this._outputDataConfig != null;
}
///
/// Gets and sets the property RoleArn.
///
/// The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
/// tasks on behalf of a user. It can access user resources, run an Amazon Braket job
/// container on behalf of user, and output resources to the users' s3 buckets.
///
///
[AWSProperty(Required=true)]
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 StoppingCondition.
///
/// The user-defined criteria that specifies when a job stops running.
///
///
public JobStoppingCondition StoppingCondition
{
get { return this._stoppingCondition; }
set { this._stoppingCondition = value; }
}
// Check to see if StoppingCondition property is set
internal bool IsSetStoppingCondition()
{
return this._stoppingCondition != null;
}
///
/// Gets and sets the property Tags.
///
/// A tag object that consists of a key and an optional value, used to manage metadata
/// for Amazon Braket resources.
///
///
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;
}
}
}