Interface CreateJobRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,BraketRequest.Builder,Buildable,CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>,SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateJobRequest
public static interface CreateJobRequest.Builder extends BraketRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateJobRequest.BuilderalgorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification)Definition of the Amazon Braket job to be created.CreateJobRequest.BuilderalgorithmSpecification(AlgorithmSpecification algorithmSpecification)Definition of the Amazon Braket job to be created.CreateJobRequest.Builderassociations(Collection<Association> associations)The list of Amazon Braket resources associated with the hybrid job.CreateJobRequest.Builderassociations(Consumer<Association.Builder>... associations)The list of Amazon Braket resources associated with the hybrid job.CreateJobRequest.Builderassociations(Association... associations)The list of Amazon Braket resources associated with the hybrid job.default CreateJobRequest.BuildercheckpointConfig(Consumer<JobCheckpointConfig.Builder> checkpointConfig)Information about the output locations for job checkpoint data.CreateJobRequest.BuildercheckpointConfig(JobCheckpointConfig checkpointConfig)Information about the output locations for job checkpoint data.CreateJobRequest.BuilderclientToken(String clientToken)A unique token that guarantees that the call to this API is idempotent.default CreateJobRequest.BuilderdeviceConfig(Consumer<DeviceConfig.Builder> deviceConfig)The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.CreateJobRequest.BuilderdeviceConfig(DeviceConfig deviceConfig)The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.CreateJobRequest.BuilderhyperParameters(Map<String,String> hyperParameters)Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job.CreateJobRequest.BuilderinputDataConfig(Collection<InputFileConfig> inputDataConfig)A list of parameters that specify the name and type of input data and where it is located.CreateJobRequest.BuilderinputDataConfig(Consumer<InputFileConfig.Builder>... inputDataConfig)A list of parameters that specify the name and type of input data and where it is located.CreateJobRequest.BuilderinputDataConfig(InputFileConfig... inputDataConfig)A list of parameters that specify the name and type of input data and where it is located.default CreateJobRequest.BuilderinstanceConfig(Consumer<InstanceConfig.Builder> instanceConfig)Configuration of the resource instances to use while running the hybrid job on Amazon Braket.CreateJobRequest.BuilderinstanceConfig(InstanceConfig instanceConfig)Configuration of the resource instances to use while running the hybrid job on Amazon Braket.CreateJobRequest.BuilderjobName(String jobName)The name of the Amazon Braket job.default CreateJobRequest.BuilderoutputDataConfig(Consumer<JobOutputDataConfig.Builder> outputDataConfig)The path to the S3 location where you want to store job artifacts and the encryption key used to store them.CreateJobRequest.BuilderoutputDataConfig(JobOutputDataConfig outputDataConfig)The path to the S3 location where you want to store job artifacts and the encryption key used to store them.CreateJobRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateJobRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateJobRequest.BuilderroleArn(String roleArn)The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.default CreateJobRequest.BuilderstoppingCondition(Consumer<JobStoppingCondition.Builder> stoppingCondition)The user-defined criteria that specifies when a job stops running.CreateJobRequest.BuilderstoppingCondition(JobStoppingCondition stoppingCondition)The user-defined criteria that specifies when a job stops running.CreateJobRequest.Buildertags(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 interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.braket.model.BraketRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
algorithmSpecification
CreateJobRequest.Builder algorithmSpecification(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.
-
algorithmSpecification
default CreateJobRequest.Builder algorithmSpecification(Consumer<AlgorithmSpecification.Builder> 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.
This is a convenience method that creates an instance of theAlgorithmSpecification.Builderavoiding the need to create one manually viaAlgorithmSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toalgorithmSpecification(AlgorithmSpecification).- Parameters:
algorithmSpecification- a consumer that will call methods onAlgorithmSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
algorithmSpecification(AlgorithmSpecification)
-
associations
CreateJobRequest.Builder associations(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.
-
associations
CreateJobRequest.Builder associations(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.
-
associations
CreateJobRequest.Builder associations(Consumer<Association.Builder>... associations)
The list of Amazon Braket resources associated with the hybrid job.
This is a convenience method that creates an instance of theAssociation.Builderavoiding the need to create one manually viaAssociation.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#associations(List.) - Parameters:
associations- a consumer that will call methods onAssociation.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#associations(java.util.Collection)
-
checkpointConfig
CreateJobRequest.Builder checkpointConfig(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.
-
checkpointConfig
default CreateJobRequest.Builder checkpointConfig(Consumer<JobCheckpointConfig.Builder> checkpointConfig)
Information about the output locations for job checkpoint data.
This is a convenience method that creates an instance of theJobCheckpointConfig.Builderavoiding the need to create one manually viaJobCheckpointConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocheckpointConfig(JobCheckpointConfig).- Parameters:
checkpointConfig- a consumer that will call methods onJobCheckpointConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
checkpointConfig(JobCheckpointConfig)
-
clientToken
CreateJobRequest.Builder clientToken(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.
-
deviceConfig
CreateJobRequest.Builder deviceConfig(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.
-
deviceConfig
default CreateJobRequest.Builder deviceConfig(Consumer<DeviceConfig.Builder> deviceConfig)
The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
This is a convenience method that creates an instance of theDeviceConfig.Builderavoiding the need to create one manually viaDeviceConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todeviceConfig(DeviceConfig).- Parameters:
deviceConfig- a consumer that will call methods onDeviceConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
deviceConfig(DeviceConfig)
-
hyperParameters
CreateJobRequest.Builder hyperParameters(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.
-
inputDataConfig
CreateJobRequest.Builder inputDataConfig(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.
-
inputDataConfig
CreateJobRequest.Builder inputDataConfig(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.
-
inputDataConfig
CreateJobRequest.Builder inputDataConfig(Consumer<InputFileConfig.Builder>... inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
This is a convenience method that creates an instance of theInputFileConfig.Builderavoiding the need to create one manually viaInputFileConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#inputDataConfig(List.) - Parameters:
inputDataConfig- a consumer that will call methods onInputFileConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#inputDataConfig(java.util.Collection)
-
instanceConfig
CreateJobRequest.Builder instanceConfig(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.
-
instanceConfig
default CreateJobRequest.Builder instanceConfig(Consumer<InstanceConfig.Builder> instanceConfig)
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
This is a convenience method that creates an instance of theInstanceConfig.Builderavoiding the need to create one manually viaInstanceConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toinstanceConfig(InstanceConfig).- Parameters:
instanceConfig- a consumer that will call methods onInstanceConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
instanceConfig(InstanceConfig)
-
jobName
CreateJobRequest.Builder jobName(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.
-
outputDataConfig
CreateJobRequest.Builder outputDataConfig(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.
-
outputDataConfig
default CreateJobRequest.Builder outputDataConfig(Consumer<JobOutputDataConfig.Builder> outputDataConfig)
The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
This is a convenience method that creates an instance of theJobOutputDataConfig.Builderavoiding the need to create one manually viaJobOutputDataConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooutputDataConfig(JobOutputDataConfig).- Parameters:
outputDataConfig- a consumer that will call methods onJobOutputDataConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
outputDataConfig(JobOutputDataConfig)
-
roleArn
CreateJobRequest.Builder roleArn(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.
-
stoppingCondition
CreateJobRequest.Builder stoppingCondition(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.
-
stoppingCondition
default CreateJobRequest.Builder stoppingCondition(Consumer<JobStoppingCondition.Builder> stoppingCondition)
The user-defined criteria that specifies when a job stops running.
This is a convenience method that creates an instance of theJobStoppingCondition.Builderavoiding the need to create one manually viaJobStoppingCondition.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tostoppingCondition(JobStoppingCondition).- Parameters:
stoppingCondition- a consumer that will call methods onJobStoppingCondition.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
stoppingCondition(JobStoppingCondition)
-
tags
CreateJobRequest.Builder tags(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.
-
overrideConfiguration
CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-