JobStub

class ansys.speos.core.kernel.job.JobStub(channel)

Bases: ansys.speos.core.kernel.crud.CrudStub

Database interactions for job.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

The best way to get a JobStub is to retrieve it from SpeosClient via jobs() method. Like in the following example:

>>> from ansys.speos.core.speos import Speos
>>> speos = Speos(host="localhost", port=50098)
>>> job_db = speos.client.jobs()

Overview

Methods

create	Create a new entry.
read	Get an existing entry.
update	Change an existing entry.
delete	Remove an existing entry.
list	List existing entries.

Import detail

from ansys.speos.core.kernel.job import JobStub

Method detail

JobStub.create(message)

Create a new entry.

Parameters:

messagejob.Job

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.job.JobLink

Link object created.

JobStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.job.JobLink

Link object to read.

Returns:

job.Job

Datamodel of the entry.

JobStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.job.JobLink

Link object to update.

datajob.Job

New datamodel for the entry.

JobStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.job.JobLink

Link object to delete.

JobStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.job.JobLink]

Link objects.