software.amazon.awssdk.services.braket.model

Interface GetJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BraketResponse.Builder, Buildable, CopyableBuilder<GetJobResponse.Builder,GetJobResponse>, SdkBuilder<GetJobResponse.Builder,GetJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetJobResponse

public static interface GetJobResponse.Builder
extends BraketResponse.Builder, SdkPojo, CopyableBuilder<GetJobResponse.Builder,GetJobResponse>

Method Summary

Modifier and Type	Method and Description
GetJobResponse.Builder	algorithmSpecification(AlgorithmSpecification algorithmSpecification) Definition of the Amazon Braket job created.
default GetJobResponse.Builder	algorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification) Definition of the Amazon Braket job created.
GetJobResponse.Builder	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.
GetJobResponse.Builder	checkpointConfig(JobCheckpointConfig checkpointConfig) Information about the output locations for job checkpoint data.
GetJobResponse.Builder	createdAt(Instant createdAt) 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.
GetJobResponse.Builder	deviceConfig(DeviceConfig deviceConfig) The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
GetJobResponse.Builder	endedAt(Instant endedAt) The date and time that the Amazon Braket job ended.
GetJobResponse.Builder	events(Collection<JobEventDetails> events) Details about the type and time events occurred related to the Amazon Braket job.
GetJobResponse.Builder	events(Consumer<JobEventDetails.Builder>... events) Details about the type and time events occurred related to the Amazon Braket job.
GetJobResponse.Builder	events(JobEventDetails... events) Details about the type and time events occurred related to the Amazon Braket job.
GetJobResponse.Builder	failureReason(String failureReason) A description of the reason why an Amazon Braket job failed, if it failed.
GetJobResponse.Builder	hyperParameters(Map<String,String> hyperParameters) Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job.
GetJobResponse.Builder	inputDataConfig(Collection<InputFileConfig> inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.
GetJobResponse.Builder	inputDataConfig(Consumer<InputFileConfig.Builder>... inputDataConfig) A list of parameters that specify the name and type of input data and where it is located.
GetJobResponse.Builder	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.
GetJobResponse.Builder	instanceConfig(InstanceConfig instanceConfig) The resource instances to use while running the hybrid job on Amazon Braket.
GetJobResponse.Builder	jobArn(String jobArn) The ARN of the Amazon Braket job.
GetJobResponse.Builder	jobName(String jobName) 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.
GetJobResponse.Builder	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.
GetJobResponse.Builder	queueInfo(HybridJobQueueInfo queueInfo) Queue information for the requested job.
GetJobResponse.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.
GetJobResponse.Builder	startedAt(Instant startedAt) The date and time that the Amazon Braket job was started.
GetJobResponse.Builder	status(JobPrimaryStatus status) The status of the Amazon Braket job.
GetJobResponse.Builder	status(String 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.
GetJobResponse.Builder	stoppingCondition(JobStoppingCondition stoppingCondition) The user-defined criteria that specifies when to stop a job running.
GetJobResponse.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.

Methods inherited from interface software.amazon.awssdk.services.braket.model.BraketResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

algorithmSpecification

GetJobResponse.Builder algorithmSpecification(AlgorithmSpecification 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 the AlgorithmSpecification.Builder avoiding the need to create one manually via AlgorithmSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to algorithmSpecification(AlgorithmSpecification).

Parameters:

algorithmSpecification - a consumer that will call methods on AlgorithmSpecification.Builder

Returns:

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

See Also:

algorithmSpecification(AlgorithmSpecification)

billableDuration

GetJobResponse.Builder billableDuration(Integer 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

GetJobResponse.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 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 the JobCheckpointConfig.Builder avoiding the need to create one manually via JobCheckpointConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to checkpointConfig(JobCheckpointConfig).

Parameters:

checkpointConfig - a consumer that will call methods on JobCheckpointConfig.Builder

Returns:

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

See Also:

checkpointConfig(JobCheckpointConfig)

createdAt

GetJobResponse.Builder createdAt(Instant 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

GetJobResponse.Builder deviceConfig(DeviceConfig 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

default GetJobResponse.Builder deviceConfig(Consumer<DeviceConfig.Builder> 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 the DeviceConfig.Builder avoiding the need to create one manually via DeviceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfig(DeviceConfig).

Parameters:

deviceConfig - a consumer that will call methods on DeviceConfig.Builder

Returns:

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

See Also:

deviceConfig(DeviceConfig)

endedAt

GetJobResponse.Builder endedAt(Instant 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

GetJobResponse.Builder events(Collection<JobEventDetails> 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

GetJobResponse.Builder events(JobEventDetails... 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

GetJobResponse.Builder events(Consumer<JobEventDetails.Builder>... 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 the JobEventDetails.Builder avoiding the need to create one manually via JobEventDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #events(List).

Parameters:

events - a consumer that will call methods on JobEventDetails.Builder

Returns:

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

See Also:

#events(java.util.Collection)

failureReason

GetJobResponse.Builder failureReason(String 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

GetJobResponse.Builder hyperParameters(Map<String,String> 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

GetJobResponse.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

GetJobResponse.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

GetJobResponse.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 the InputFileConfig.Builder avoiding the need to create one manually via InputFileConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #inputDataConfig(List).

Parameters:

inputDataConfig - a consumer that will call methods on InputFileConfig.Builder

Returns:

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

See Also:

#inputDataConfig(java.util.Collection)

instanceConfig

GetJobResponse.Builder instanceConfig(InstanceConfig 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

default GetJobResponse.Builder instanceConfig(Consumer<InstanceConfig.Builder> instanceConfig)

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

This is a convenience method that creates an instance of the InstanceConfig.Builder avoiding the need to create one manually via InstanceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceConfig(InstanceConfig).

Parameters:

instanceConfig - a consumer that will call methods on InstanceConfig.Builder

Returns:

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

See Also:

instanceConfig(InstanceConfig)

jobArn

GetJobResponse.Builder jobArn(String 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

GetJobResponse.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

GetJobResponse.Builder outputDataConfig(JobOutputDataConfig 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 the JobOutputDataConfig.Builder avoiding the need to create one manually via JobOutputDataConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(JobOutputDataConfig).

Parameters:

outputDataConfig - a consumer that will call methods on JobOutputDataConfig.Builder

Returns:

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

See Also:

outputDataConfig(JobOutputDataConfig)

queueInfo

GetJobResponse.Builder queueInfo(HybridJobQueueInfo queueInfo)

Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

Parameters:

queueInfo - Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

Returns:

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

queueInfo

default GetJobResponse.Builder queueInfo(Consumer<HybridJobQueueInfo.Builder> queueInfo)

Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

This is a convenience method that creates an instance of the HybridJobQueueInfo.Builder avoiding the need to create one manually via HybridJobQueueInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queueInfo(HybridJobQueueInfo).

Parameters:

queueInfo - a consumer that will call methods on HybridJobQueueInfo.Builder

Returns:

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

See Also:

queueInfo(HybridJobQueueInfo)

roleArn

GetJobResponse.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 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

GetJobResponse.Builder startedAt(Instant 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

GetJobResponse.Builder status(String 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:

JobPrimaryStatus, JobPrimaryStatus

status

GetJobResponse.Builder status(JobPrimaryStatus 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:

JobPrimaryStatus, JobPrimaryStatus

stoppingCondition

GetJobResponse.Builder stoppingCondition(JobStoppingCondition 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 the JobStoppingCondition.Builder avoiding the need to create one manually via JobStoppingCondition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stoppingCondition(JobStoppingCondition).

Parameters:

stoppingCondition - a consumer that will call methods on JobStoppingCondition.Builder

Returns:

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

See Also:

stoppingCondition(JobStoppingCondition)

tags

GetJobResponse.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.