Package com.azure.quantum.jobs

Class JobsAsyncClient

java.lang.Object

com.azure.quantum.jobs.JobsAsyncClient

public final class JobsAsyncClient
extends Object

Initializes a new instance of the asynchronous QuantumClient type.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	cancel(String jobId)	Cancel a job.
Mono<Response<Void>>	cancelWithResponse(String jobId)	Cancel a job.
Mono<JobDetails>	create(String jobId, JobDetails job)	Create a job.
Mono<Response<JobDetails>>	createWithResponse(String jobId, JobDetails job)	Create a job.
Mono<JobDetails>	get(String jobId)	Get job by id.
Mono<Response<JobDetails>>	getWithResponse(String jobId)	Get job by id.
PagedFlux<JobDetails>	list()	List jobs.
Mono<PagedResponse<JobDetails>>	listNextSinglePage(String nextLink)	Get the next page of items.
Mono<PagedResponse<JobDetails>>	listSinglePage()	List jobs.

Methods inherited from class java.lang.Object

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

Method Details

listSinglePage

public Mono<PagedResponse<JobDetails>> listSinglePage()

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.

list

public PagedFlux<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.

getWithResponse

public Mono<Response<JobDetails>> getWithResponse(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.

get

public Mono<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.

createWithResponse

public Mono<Response<JobDetails>> createWithResponse(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.

create

public Mono<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.

cancelWithResponse

public Mono<Response<Void>> cancelWithResponse(String jobId)

Cancel a job.

Parameters:

jobId - Id of the job.

Returns:

the completion.

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 Mono<Void> cancel(String jobId)

Cancel a job.

Parameters:

jobId - Id of the job.

Returns:

the completion.

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.

listNextSinglePage

public Mono<PagedResponse<JobDetails>> listNextSinglePage(String nextLink)

Get the next page of items.

Parameters:

nextLink - The nextLink parameter.

Returns:

list of job details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

HttpResponseException - thrown if the request is rejected by server.

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