Package com.azure.quantum.jobs

Class JobsClient

java.lang.Object

com.azure.quantum.jobs.JobsClient

public final class JobsClient
extends Object

Initializes a new instance of the synchronous QuantumClient type.

Method Summary

Modifier and Type	Method	Description
void	cancel(String jobId)	Cancel a job.
JobDetails	create(String jobId, JobDetails job)	Create a job.
JobDetails	get(String jobId)	Get job by id.
PagedIterable<JobDetails>	list()	List jobs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

list

public PagedIterable<JobDetails> list()

List jobs.

Returns:

list of job details.

Throws:

HttpResponseException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

public JobDetails get(String jobId)

Get job by id.

Parameters:

jobId - Id of the job.

Returns:

job by id.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

RestErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

create

public JobDetails create(String jobId,
 JobDetails job)

Create a job.

Parameters:

jobId - Id of the job.

job - The complete metadata of the job to submit.

Returns:

job details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

RestErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

cancel

public void cancel(String jobId)

Cancel a job.

Parameters:

jobId - Id of the job.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

RestErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.