Skip to content

JobRequest

Bases: BaseModel

Request to run a VQE job.

Source code in q3as/api.py
class JobRequest(BaseModel):
    """
    Request to run a VQE job.
    """

    input: EncodedVQE
    "The input VQE to run."
    run_options: RunOptions = RunOptions()
    "The options to run the VQE with."

    def send(self, client: Client) -> Job:
        """
        Send the request to the server and create a job.
        """
        return client.create_job(self)

input: EncodedVQE instance-attribute

The input VQE to run.

run_options: RunOptions = RunOptions() class-attribute instance-attribute

The options to run the VQE with.

send(client)

Send the request to the server and create a job.

Source code in q3as/api.py
def send(self, client: Client) -> Job:
    """
    Send the request to the server and create a job.
    """
    return client.create_job(self)