ai_core_sdk.resource_clients.kpi_client
index
/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/kpi_client.py

 
Classes
       
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object)
KpiClient

 
class KpiClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
    KpiClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
 
KpiClient is a class implemented for interacting with the analytics kpi
endpoint of the server. It implements the base class
:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
KpiClient
ai_api_client_sdk.resource_clients.base_client.BaseClient
builtins.object

Methods defined here:
query(self) -> ai_core_sdk.models.kpi.Kpi
Retrieves the number of executions, artifacts, and deployments
for each resource group, scenario, and executable.
 
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
    trying to send a request to the server
:return: The retrieved KPI data
:rtype: class:`ai_core_sdk.models.kpi.Kpi`

Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients

Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)