com.amazonaws.services.braket.model

Class CreateJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.braket.model.CreateJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateJobRequest	addHyperParametersEntry(String key, String value) Add a single HyperParameters entry
CreateJobRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateJobRequest	clearHyperParametersEntries() Removes all the entries added into HyperParameters.
CreateJobRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AlgorithmSpecification	getAlgorithmSpecification() Definition of the Amazon Braket job to be created.
List<Association>	getAssociations() The list of Amazon Braket resources associated with the hybrid job.
JobCheckpointConfig	getCheckpointConfig() Information about the output locations for job checkpoint data.
String	getClientToken() A unique token that guarantees that the call to this API is idempotent.
DeviceConfig	getDeviceConfig() The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
Map<String,String>	getHyperParameters() Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job.
List<InputFileConfig>	getInputDataConfig() A list of parameters that specify the name and type of input data and where it is located.
InstanceConfig	getInstanceConfig() Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
String	getJobName() The name of the Amazon Braket job.
JobOutputDataConfig	getOutputDataConfig() The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.
JobStoppingCondition	getStoppingCondition() The user-defined criteria that specifies when a job stops running.
Map<String,String>	getTags() A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
int	hashCode()
void	setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification) Definition of the Amazon Braket job to be created.
void	setAssociations(Collection<Association> associations) The list of Amazon Braket resources associated with the hybrid job.
void	setCheckpointConfig(JobCheckpointConfig checkpointConfig) Information about the output locations for job checkpoint data.
void	setClientToken(String clientToken) A unique token that guarantees that the call to this API is idempotent.
void	setDeviceConfig(DeviceConfig deviceConfig) The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
void	setHyperParameters(Map<String,String> hyperParameters) Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job.
void	setInputDataConfig(Collection<InputFileConfig> inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.
void	setInstanceConfig(InstanceConfig instanceConfig) Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
void	setJobName(String jobName) The name of the Amazon Braket job.
void	setOutputDataConfig(JobOutputDataConfig outputDataConfig) The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.
void	setStoppingCondition(JobStoppingCondition stoppingCondition) The user-defined criteria that specifies when a job stops running.
void	setTags(Map<String,String> tags) A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
String	toString() Returns a string representation of this object.
CreateJobRequest	withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification) Definition of the Amazon Braket job to be created.
CreateJobRequest	withAssociations(Association... associations) The list of Amazon Braket resources associated with the hybrid job.
CreateJobRequest	withAssociations(Collection<Association> associations) The list of Amazon Braket resources associated with the hybrid job.
CreateJobRequest	withCheckpointConfig(JobCheckpointConfig checkpointConfig) Information about the output locations for job checkpoint data.
CreateJobRequest	withClientToken(String clientToken) A unique token that guarantees that the call to this API is idempotent.
CreateJobRequest	withDeviceConfig(DeviceConfig deviceConfig) The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
CreateJobRequest	withHyperParameters(Map<String,String> hyperParameters) Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job.
CreateJobRequest	withInputDataConfig(Collection<InputFileConfig> inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.
CreateJobRequest	withInputDataConfig(InputFileConfig... inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.
CreateJobRequest	withInstanceConfig(InstanceConfig instanceConfig) Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
CreateJobRequest	withJobName(String jobName) The name of the Amazon Braket job.
CreateJobRequest	withOutputDataConfig(JobOutputDataConfig outputDataConfig) The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
CreateJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.
CreateJobRequest	withStoppingCondition(JobStoppingCondition stoppingCondition) The user-defined criteria that specifies when a job stops running.
CreateJobRequest	withTags(Map<String,String> tags) A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateJobRequest

public CreateJobRequest()

Method Detail

setAlgorithmSpecification

public void setAlgorithmSpecification(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.

Parameters:

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.

getAlgorithmSpecification

public AlgorithmSpecification getAlgorithmSpecification()

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.

Returns:

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.

withAlgorithmSpecification

public CreateJobRequest withAlgorithmSpecification(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAssociations

public List<Association> getAssociations()

The list of Amazon Braket resources associated with the hybrid job.

Returns:

The list of Amazon Braket resources associated with the hybrid job.

setAssociations

public void setAssociations(Collection<Association> associations)

The list of Amazon Braket resources associated with the hybrid job.

Parameters:

associations - The list of Amazon Braket resources associated with the hybrid job.

withAssociations

public CreateJobRequest withAssociations(Association... associations)

The list of Amazon Braket resources associated with the hybrid job.

NOTE: This method appends the values to the existing list (if any). Use setAssociations(java.util.Collection) or withAssociations(java.util.Collection) if you want to override the existing values.

Parameters:

associations - The list of Amazon Braket resources associated with the hybrid job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAssociations

public CreateJobRequest withAssociations(Collection<Association> associations)

The list of Amazon Braket resources associated with the hybrid job.

Parameters:

associations - The list of Amazon Braket resources associated with the hybrid job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCheckpointConfig

public void setCheckpointConfig(JobCheckpointConfig checkpointConfig)

Information about the output locations for job checkpoint data.

Parameters:

checkpointConfig - Information about the output locations for job checkpoint data.

getCheckpointConfig

public JobCheckpointConfig getCheckpointConfig()

Information about the output locations for job checkpoint data.

Returns:

Information about the output locations for job checkpoint data.

withCheckpointConfig

public CreateJobRequest withCheckpointConfig(JobCheckpointConfig checkpointConfig)

Information about the output locations for job checkpoint data.

Parameters:

checkpointConfig - Information about the output locations for job checkpoint data.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

A unique token that guarantees that the call to this API is idempotent.

Parameters:

clientToken - A unique token that guarantees that the call to this API is idempotent.

getClientToken

public String getClientToken()

A unique token that guarantees that the call to this API is idempotent.

Returns:

A unique token that guarantees that the call to this API is idempotent.

withClientToken

public CreateJobRequest withClientToken(String clientToken)

A unique token that guarantees that the call to this API is idempotent.

Parameters:

clientToken - A unique token that guarantees that the call to this API is idempotent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeviceConfig

public void setDeviceConfig(DeviceConfig deviceConfig)

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Parameters:

deviceConfig - The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

getDeviceConfig

public DeviceConfig getDeviceConfig()

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Returns:

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

withDeviceConfig

public CreateJobRequest withDeviceConfig(DeviceConfig deviceConfig)

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Parameters:

deviceConfig - The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Returns:

Returns a reference to this object so that method calls can be chained together.

getHyperParameters

public Map<String,String> getHyperParameters()

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.

Returns:

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.

setHyperParameters

public void setHyperParameters(Map<String,String> 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.

Parameters:

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.

withHyperParameters

public CreateJobRequest withHyperParameters(Map<String,String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addHyperParametersEntry

public CreateJobRequest addHyperParametersEntry(String key,
                                                String value)

Add a single HyperParameters entry

See Also:

withHyperParameters(java.util.Map<java.lang.String, java.lang.String>)

clearHyperParametersEntries

public CreateJobRequest clearHyperParametersEntries()

Removes all the entries added into HyperParameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

getInputDataConfig

public List<InputFileConfig> getInputDataConfig()

A list of parameters that specify the name and type of input data and where it is located.

Returns:

A list of parameters that specify the name and type of input data and where it is located.

setInputDataConfig

public void setInputDataConfig(Collection<InputFileConfig> inputDataConfig)

A list of parameters that specify the name and type of input data and where it is located.

Parameters:

inputDataConfig - A list of parameters that specify the name and type of input data and where it is located.

withInputDataConfig

public CreateJobRequest withInputDataConfig(InputFileConfig... inputDataConfig)

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 setInputDataConfig(java.util.Collection) or withInputDataConfig(java.util.Collection) if you want to override the existing values.

Parameters:

inputDataConfig - A list of parameters that specify the name and type of input data and where it is located.

Returns:

Returns a reference to this object so that method calls can be chained together.

withInputDataConfig

public CreateJobRequest withInputDataConfig(Collection<InputFileConfig> inputDataConfig)

A list of parameters that specify the name and type of input data and where it is located.

Parameters:

inputDataConfig - A list of parameters that specify the name and type of input data and where it is located.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceConfig

public void setInstanceConfig(InstanceConfig instanceConfig)

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

Parameters:

instanceConfig - Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

getInstanceConfig

public InstanceConfig getInstanceConfig()

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

Returns:

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

withInstanceConfig

public CreateJobRequest withInstanceConfig(InstanceConfig instanceConfig)

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

Parameters:

instanceConfig - Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

Returns:

Returns a reference to this object so that method calls can be chained together.

setJobName

public void setJobName(String jobName)

The name of the Amazon Braket job.

Parameters:

jobName - The name of the Amazon Braket job.

getJobName

public String getJobName()

The name of the Amazon Braket job.

Returns:

The name of the Amazon Braket job.

withJobName

public CreateJobRequest withJobName(String jobName)

The name of the Amazon Braket job.

Parameters:

jobName - The name of the Amazon Braket job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputDataConfig

public void setOutputDataConfig(JobOutputDataConfig outputDataConfig)

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

Parameters:

outputDataConfig - The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

getOutputDataConfig

public JobOutputDataConfig getOutputDataConfig()

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

Returns:

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

withOutputDataConfig

public CreateJobRequest withOutputDataConfig(JobOutputDataConfig outputDataConfig)

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

Parameters:

outputDataConfig - The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(String 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.

Parameters:

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.

getRoleArn

public String getRoleArn()

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.

Returns:

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.

withRoleArn

public CreateJobRequest withRoleArn(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStoppingCondition

public void setStoppingCondition(JobStoppingCondition stoppingCondition)

The user-defined criteria that specifies when a job stops running.

Parameters:

stoppingCondition - The user-defined criteria that specifies when a job stops running.

getStoppingCondition

public JobStoppingCondition getStoppingCondition()

The user-defined criteria that specifies when a job stops running.

Returns:

The user-defined criteria that specifies when a job stops running.

withStoppingCondition

public CreateJobRequest withStoppingCondition(JobStoppingCondition stoppingCondition)

The user-defined criteria that specifies when a job stops running.

Parameters:

stoppingCondition - The user-defined criteria that specifies when a job stops running.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Returns:

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

setTags

public void setTags(Map<String,String> tags)

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Parameters:

tags - A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

withTags

public CreateJobRequest withTags(Map<String,String> tags)

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Parameters:

tags - A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateJobRequest addTagsEntry(String key,
                                     String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateJobRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()