ai_api_client_sdk.resource_clients.metrics_client
index
/home/jenkins/agent/workspace/ndation_ai-api-client-sdk_master/ai_api_client_sdk/resource_clients/metrics_client.py

 
Modules
       
warnings

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

 
class MetricsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
    MetricsClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
 
MetricsClient is a class implemented for interacting with the metrics related endpoints of the server. It
implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
MetricsClient
ai_api_client_sdk.resource_clients.base_client.BaseClient
builtins.object

Methods defined here:
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
 
:param execution_id: ID of the execution, of which the metrics should be deleted.
:type execution_id: str
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
    defaults to None
:type resource_group: str
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
    server
: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
query(self, filter: str = None, execution_ids: List[str] = None, select: List[str] = None, resource_group: str = None) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Queries the metrics.
 
:param filter: Deprecated. Use parameter execution_ids instead. A filter expression that filters the metric
    resources using execution IDs. User can only use in, eq operators in filter expression, defaults to None
:type filter: str, optional
:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
:type execution_ids: List[str], optional
:param select: Values of select can be metrics,tags,customInfo or any of the combinations of these or *. 
    Can be used to select(project) only the resources specified
:type select: List[str], optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
    defaults to None
:type resource_group: str
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
    server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`

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.
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
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
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)

 
Data
        List = typing.List