JmsApi

class ansys.hps.client.jms.api.JmsApi(client)

Wraps around the JMS root endpoints.

Parameters:

clientClient

HPS client object.

Examples

Create a project.

>>> from ansys.hps.client import Client
>>> from ansys.hps.client.jms import JmsApi, Project
>>> cl = Client(
...     url="https://127.0.0.1:8443/hps", username="repuser", password="repuser"
... )
>>> jms_api = JmsApi(cl)
>>> project = jms_api.create_project(Project(name="Example project"))

Initialize JMS API.

Methods

JmsApi.copy_task_definition_templates(templates)	Create task definition templates by copying existing templates.
JmsApi.create_project(project[, replace, ...])	Create a project.
JmsApi.create_task_definition_templates(...)	Create task definition templates.
JmsApi.delete_project(project)	Delete a project.
JmsApi.delete_task_definition_templates(...)	Delete task definition templates.
JmsApi.get_api_info()	Get information of the JMS API that the client is connected to.
JmsApi.get_operation(id[, as_object])	Get an operation.
JmsApi.get_operations([as_objects])	Get operations.
JmsApi.get_project(id)	Get a single project for a given project ID.
JmsApi.get_project_by_name(name[, last_created])	Query projects by name.
JmsApi.get_projects([as_objects])	Get a list of projects, optionally filtered by query parameters.
JmsApi.get_storage()	Get a list of storages.
JmsApi.get_task_definition_template_permissions(...)	Get permissions of a task definition template.
JmsApi.get_task_definition_templates([...])	Get a list of task definition templates, optionally filtered by query parameters.
JmsApi.monitor_operation(operation_id[, ...])	Poll an operation until it is completed using an exponential backoff.
JmsApi.restore_project(path)	Restore a project from an archive.
JmsApi.update_project(project[, as_objects])	Update a project.
JmsApi.update_task_definition_template_permissions(...)	Update permissions of a task definition template.
JmsApi.update_task_definition_templates(...)	Update task definition templates.

Attributes

JmsApi.fs_url	URL of the file storage gateway.
JmsApi.url	URL of the API.