Interface GetJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,BraketResponse.Builder
,Buildable
,CopyableBuilder<GetJobResponse.Builder,
,GetJobResponse> SdkBuilder<GetJobResponse.Builder,
,GetJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetJobResponse
-
Method Summary
Modifier and TypeMethodDescriptiondefault GetJobResponse.Builder
algorithmSpecification
(Consumer<AlgorithmSpecification.Builder> algorithmSpecification) Definition of the Amazon Braket job created.algorithmSpecification
(AlgorithmSpecification algorithmSpecification) Definition of the Amazon Braket job created.associations
(Collection<Association> associations) The list of Amazon Braket resources associated with the hybrid job.associations
(Consumer<Association.Builder>... associations) The list of Amazon Braket resources associated with the hybrid job.associations
(Association... associations) The list of Amazon Braket resources associated with the hybrid job.billableDuration
(Integer billableDuration) The billable time the Amazon Braket job used to complete.default GetJobResponse.Builder
checkpointConfig
(Consumer<JobCheckpointConfig.Builder> checkpointConfig) Information about the output locations for job checkpoint data.checkpointConfig
(JobCheckpointConfig checkpointConfig) Information about the output locations for job checkpoint data.The date and time that the Amazon Braket job was created.default GetJobResponse.Builder
deviceConfig
(Consumer<DeviceConfig.Builder> deviceConfig) The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.deviceConfig
(DeviceConfig deviceConfig) The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.The date and time that the Amazon Braket job ended.events
(Collection<JobEventDetails> events) Details about the type and time events occurred related to the Amazon Braket job.events
(Consumer<JobEventDetails.Builder>... events) Details about the type and time events occurred related to the Amazon Braket job.events
(JobEventDetails... events) Details about the type and time events occurred related to the Amazon Braket job.failureReason
(String failureReason) A description of the reason why an Amazon Braket job failed, if it failed.hyperParameters
(Map<String, String> hyperParameters) Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job.inputDataConfig
(Collection<InputFileConfig> inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.inputDataConfig
(Consumer<InputFileConfig.Builder>... inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.inputDataConfig
(InputFileConfig... inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.default GetJobResponse.Builder
instanceConfig
(Consumer<InstanceConfig.Builder> instanceConfig) The resource instances to use while running the hybrid job on Amazon Braket.instanceConfig
(InstanceConfig instanceConfig) The resource instances to use while running the hybrid job on Amazon Braket.The ARN of the Amazon Braket job.The name of the Amazon Braket job.default GetJobResponse.Builder
outputDataConfig
(Consumer<JobOutputDataConfig.Builder> outputDataConfig) The path to the S3 location where job artifacts are stored and the encryption key used to store them there.outputDataConfig
(JobOutputDataConfig outputDataConfig) The path to the S3 location where job artifacts are stored and the encryption key used to store them there.default GetJobResponse.Builder
queueInfo
(Consumer<HybridJobQueueInfo.Builder> queueInfo) Queue information for the requested job.queueInfo
(HybridJobQueueInfo queueInfo) Queue information for the requested job.The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.The date and time that the Amazon Braket job was started.The status of the Amazon Braket job.status
(JobPrimaryStatus status) The status of the Amazon Braket job.default GetJobResponse.Builder
stoppingCondition
(Consumer<JobStoppingCondition.Builder> stoppingCondition) The user-defined criteria that specifies when to stop a job running.stoppingCondition
(JobStoppingCondition stoppingCondition) The user-defined criteria that specifies when to stop a job running.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.services.braket.model.BraketResponse.Builder
build, responseMetadata, responseMetadata
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
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
algorithmSpecification
Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
- Parameters:
algorithmSpecification
- Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
algorithmSpecification
default GetJobResponse.Builder algorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification) Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
This is a convenience method that creates an instance of theAlgorithmSpecification.Builder
avoiding the need to create one manually viaAlgorithmSpecification.builder()
.When the
Consumer
completes,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:
-
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
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
The list of Amazon Braket resources associated with the hybrid job.
This is a convenience method that creates an instance of theAssociation.Builder
avoiding the need to create one manually viaAssociation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toassociations(List<Association>)
.- 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:
-
billableDuration
The billable time the Amazon Braket job used to complete.
- Parameters:
billableDuration
- The billable time the Amazon Braket job used to complete.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 GetJobResponse.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.Builder
avoiding the need to create one manually viaJobCheckpointConfig.builder()
.When the
Consumer
completes,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:
-
createdAt
The date and time that the Amazon Braket job was created.
- Parameters:
createdAt
- The date and time that the Amazon Braket job was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deviceConfig
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
- Parameters:
deviceConfig
- The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deviceConfig
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
This is a convenience method that creates an instance of theDeviceConfig.Builder
avoiding the need to create one manually viaDeviceConfig.builder()
.When the
Consumer
completes,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:
-
endedAt
The date and time that the Amazon Braket job ended.
- Parameters:
endedAt
- The date and time that the Amazon Braket job ended.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
events
Details about the type and time events occurred related to the Amazon Braket job.
- Parameters:
events
- Details about the type and time events occurred related to the Amazon Braket job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
events
Details about the type and time events occurred related to the Amazon Braket job.
- Parameters:
events
- Details about the type and time events occurred related to the Amazon Braket job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
events
Details about the type and time events occurred related to the Amazon Braket job.
This is a convenience method that creates an instance of theJobEventDetails.Builder
avoiding the need to create one manually viaJobEventDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toevents(List<JobEventDetails>)
.- Parameters:
events
- a consumer that will call methods onJobEventDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureReason
A description of the reason why an Amazon Braket job failed, if it failed.
- Parameters:
failureReason
- A description of the reason why an Amazon Braket job failed, if it failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hyperParameters
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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 traiing 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
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
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
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.Builder
avoiding the need to create one manually viaInputFileConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputDataConfig(List<InputFileConfig>)
.- 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:
-
instanceConfig
The resource instances to use while running the hybrid job on Amazon Braket.
- Parameters:
instanceConfig
- 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
The resource instances to use while running the hybrid job on Amazon Braket.
This is a convenience method that creates an instance of theInstanceConfig.Builder
avoiding the need to create one manually viaInstanceConfig.builder()
.When the
Consumer
completes,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:
-
jobArn
The ARN of the Amazon Braket job.
- Parameters:
jobArn
- The ARN of the Amazon Braket job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
- Parameters:
outputDataConfig
- The path to the S3 location where job artifacts are stored and the encryption key used to store them there.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputDataConfig
default GetJobResponse.Builder outputDataConfig(Consumer<JobOutputDataConfig.Builder> outputDataConfig) The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
This is a convenience method that creates an instance of theJobOutputDataConfig.Builder
avoiding the need to create one manually viaJobOutputDataConfig.builder()
.When the
Consumer
completes,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:
-
queueInfo
Queue information for the requested job. Only returned if
QueueInfo
is specified in theadditionalAttributeNames"
field in theGetJob
API request.- Parameters:
queueInfo
- Queue information for the requested job. Only returned ifQueueInfo
is specified in theadditionalAttributeNames"
field in theGetJob
API request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queueInfo
Queue information for the requested job. Only returned if
This is a convenience method that creates an instance of theQueueInfo
is specified in theadditionalAttributeNames"
field in theGetJob
API request.HybridJobQueueInfo.Builder
avoiding the need to create one manually viaHybridJobQueueInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toqueueInfo(HybridJobQueueInfo)
.- Parameters:
queueInfo
- a consumer that will call methods onHybridJobQueueInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 s3 buckets of a user.
- 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 s3 buckets of a user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedAt
The date and time that the Amazon Braket job was started.
- Parameters:
startedAt
- The date and time that the Amazon Braket job was started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the Amazon Braket job.
- Parameters:
status
- The status of the Amazon Braket job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the Amazon Braket job.
- Parameters:
status
- The status of the Amazon Braket job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stoppingCondition
The user-defined criteria that specifies when to stop a job running.
- Parameters:
stoppingCondition
- The user-defined criteria that specifies when to stop a job running.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stoppingCondition
default GetJobResponse.Builder stoppingCondition(Consumer<JobStoppingCondition.Builder> stoppingCondition) The user-defined criteria that specifies when to stop a job running.
This is a convenience method that creates an instance of theJobStoppingCondition.Builder
avoiding the need to create one manually viaJobStoppingCondition.builder()
.When the
Consumer
completes,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:
-
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.
-