/* * Copyright 2018-2023 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. */ package com.amazonaws.services.braket.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private AlgorithmSpecification algorithmSpecification; /** ** Information about the output locations for job checkpoint data. *
*/ private JobCheckpointConfig checkpointConfig; /** ** A unique token that guarantees that the call to this API is idempotent. *
*/ private String clientToken; /** ** The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. *
*/ private DeviceConfig deviceConfig; /** ** 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. *
*/ private java.util.Map* A list of parameters that specify the name and type of input data and where it is located. *
*/ private java.util.List* Configuration of the resource instances to use while running the hybrid job on Amazon Braket. *
*/ private InstanceConfig instanceConfig; /** ** The name of the Amazon Braket job. *
*/ private String jobName; /** ** The path to the S3 location where you want to store job artifacts and the encryption key used to store them. *
*/ private JobOutputDataConfig outputDataConfig; /** ** 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. *
*/ private String roleArn; /** ** The user-defined criteria that specifies when a job stops running. *
*/ private JobStoppingCondition stoppingCondition; /** ** A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources. *
*/ private java.util.Map* 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. *
* * @param 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. */ public void setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification) { this.algorithmSpecification = 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. *
* * @return 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. */ public AlgorithmSpecification getAlgorithmSpecification() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification) { setAlgorithmSpecification(algorithmSpecification); return this; } /** ** Information about the output locations for job checkpoint data. *
* * @param checkpointConfig * Information about the output locations for job checkpoint data. */ public void setCheckpointConfig(JobCheckpointConfig checkpointConfig) { this.checkpointConfig = checkpointConfig; } /** ** Information about the output locations for job checkpoint data. *
* * @return Information about the output locations for job checkpoint data. */ public JobCheckpointConfig getCheckpointConfig() { return this.checkpointConfig; } /** ** Information about the output locations for job checkpoint data. *
* * @param checkpointConfig * Information about the output locations for job checkpoint data. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withCheckpointConfig(JobCheckpointConfig checkpointConfig) { setCheckpointConfig(checkpointConfig); return this; } /** ** A unique token that guarantees that the call to this API is idempotent. *
* * @param clientToken * A unique token that guarantees that the call to this API is idempotent. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** ** A unique token that guarantees that the call to this API is idempotent. *
* * @return A unique token that guarantees that the call to this API is idempotent. */ public String getClientToken() { return this.clientToken; } /** ** A unique token that guarantees that the call to this API is idempotent. *
* * @param clientToken * A unique token that guarantees that the call to this API is idempotent. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** ** The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. *
* * @param deviceConfig * The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. */ public void setDeviceConfig(DeviceConfig deviceConfig) { this.deviceConfig = deviceConfig; } /** ** The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. *
* * @return The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. */ public DeviceConfig getDeviceConfig() { return this.deviceConfig; } /** ** The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. *
* * @param deviceConfig * The quantum processing unit (QPU) or simulator used to create an Amazon Braket job. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withDeviceConfig(DeviceConfig deviceConfig) { setDeviceConfig(deviceConfig); return this; } /** ** 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. *
* * @return 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. */ public java.util.Map* 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. *
* * @param 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. */ public void setHyperParameters(java.util.Map* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withHyperParameters(java.util.Map* A list of parameters that specify the name and type of input data and where it is located. *
* * @return A list of parameters that specify the name and type of input data and where it is located. */ public java.util.List* A list of parameters that specify the name and type of input data and where it is located. *
* * @param inputDataConfig * A list of parameters that specify the name and type of input data and where it is located. */ public void setInputDataConfig(java.util.Collection* A list of parameters that specify the name and type of input data and where it is located. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setInputDataConfig(java.util.Collection)} or {@link #withInputDataConfig(java.util.Collection)} if you * want to override the existing values. *
* * @param inputDataConfig * A list of parameters that specify the name and type of input data and where it is located. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withInputDataConfig(InputFileConfig... inputDataConfig) { if (this.inputDataConfig == null) { setInputDataConfig(new java.util.ArrayList* A list of parameters that specify the name and type of input data and where it is located. *
* * @param inputDataConfig * A list of parameters that specify the name and type of input data and where it is located. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withInputDataConfig(java.util.Collection* Configuration of the resource instances to use while running the hybrid job on Amazon Braket. *
* * @param instanceConfig * Configuration of the resource instances to use while running the hybrid job on Amazon Braket. */ public void setInstanceConfig(InstanceConfig instanceConfig) { this.instanceConfig = instanceConfig; } /** ** Configuration of the resource instances to use while running the hybrid job on Amazon Braket. *
* * @return Configuration of the resource instances to use while running the hybrid job on Amazon Braket. */ public InstanceConfig getInstanceConfig() { return this.instanceConfig; } /** ** Configuration of the resource instances to use while running the hybrid job on Amazon Braket. *
* * @param instanceConfig * Configuration of the resource instances to use while running the hybrid job on Amazon Braket. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withInstanceConfig(InstanceConfig instanceConfig) { setInstanceConfig(instanceConfig); return this; } /** ** The name of the Amazon Braket job. *
* * @param jobName * The name of the Amazon Braket job. */ public void setJobName(String jobName) { this.jobName = jobName; } /** ** The name of the Amazon Braket job. *
* * @return The name of the Amazon Braket job. */ public String getJobName() { return this.jobName; } /** ** The name of the Amazon Braket job. *
* * @param jobName * The name of the Amazon Braket job. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withJobName(String jobName) { setJobName(jobName); return this; } /** ** The path to the S3 location where you want to store job artifacts and the encryption key used to store them. *
* * @param outputDataConfig * The path to the S3 location where you want to store job artifacts and the encryption key used to store * them. */ public void setOutputDataConfig(JobOutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** ** The path to the S3 location where you want to store job artifacts and the encryption key used to store them. *
* * @return The path to the S3 location where you want to store job artifacts and the encryption key used to store * them. */ public JobOutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** ** The path to the S3 location where you want to store job artifacts and the encryption key used to store them. *
* * @param outputDataConfig * The path to the S3 location where you want to store job artifacts and the encryption key used to store * them. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withOutputDataConfig(JobOutputDataConfig outputDataConfig) { setOutputDataConfig(outputDataConfig); return this; } /** ** 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. *
* * @param 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. */ public void setRoleArn(String roleArn) { this.roleArn = 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. *
* * @return 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. */ public String getRoleArn() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** ** The user-defined criteria that specifies when a job stops running. *
* * @param stoppingCondition * The user-defined criteria that specifies when a job stops running. */ public void setStoppingCondition(JobStoppingCondition stoppingCondition) { this.stoppingCondition = stoppingCondition; } /** ** The user-defined criteria that specifies when a job stops running. *
* * @return The user-defined criteria that specifies when a job stops running. */ public JobStoppingCondition getStoppingCondition() { return this.stoppingCondition; } /** ** The user-defined criteria that specifies when a job stops running. *
* * @param stoppingCondition * The user-defined criteria that specifies when a job stops running. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withStoppingCondition(JobStoppingCondition stoppingCondition) { setStoppingCondition(stoppingCondition); return this; } /** ** A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources. *
* * @return A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket * resources. */ public java.util.Map* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources. *
* * @param tags * A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket * resources. */ public void setTags(java.util.Map* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources. *
* * @param tags * A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket * resources. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateJobRequest withTags(java.util.Map