RmsApi

class ansys.hps.client.rms.api.RmsApi(client)

Wraps around the RMS root endpoints.

Parameters:

clientClient

HPS client object.

Methods

RmsApi.analyze(requirements[, analytics, ...])	Compare resource requirements against available compute resources.
RmsApi.get_api_info()	Get information on the RMS API the client is connected to.
RmsApi.get_cluster_info(compute_resource_set_id)	Get the cluster information of a compute resource set.
RmsApi.get_compute_resource_set(id[, as_object])	Get a compute resource set.
RmsApi.get_compute_resource_sets([as_objects])	Get a list of compute resource sets, optionally filtered by query parameters.
RmsApi.get_compute_resource_sets_count(...)	Get the number of compute resource sets, optionally filtered by query parameters.
RmsApi.get_evaluator_configuration(id[, ...])	Get an evaluator's configuration
RmsApi.get_evaluators([as_objects])	Get a list of evaluators, optionally filtered by query parameters.
RmsApi.get_evaluators_count(**query_params)	Get the number of evaluators, optionally filtered by query parameters.
RmsApi.get_scalers([as_objects])	Get a list of scalers, optionally filtered by query parameters.
RmsApi.get_scalers_count(**query_params)	Get the number of scalers, optionally filtered by query parameters.
RmsApi.update_evaluator_configuration(id, ...)	Update an evaluator configuration.

Attributes

RmsApi.url

URL of the API.