ai_api_client_sdk.resource_clients.executable_client module¶

class ai_api_client_sdk.resource_clients.executable_client.ExecutableClient(rest_client: RestClient)¶

ExecutableClient is a class implemented for interacting with the executable related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

get(scenario_id: str, executable_id: str, resource_group: str = None) → Executable¶

Retrieves the executable from the server.

Parameters:

scenario_id (str) – ID of the scenario the executable belongs to
executable_id (str) – ID of the executable to be retrieved
resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

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

Returns:

The retrieved executable

Return type:

class:ai_api_client_sdk.models.executable.Executable

query(scenario_id: str, version_id: str = None, resource_group: str = None) → ExecutableQueryResponse¶

Queries the executables.

Parameters:

scenario_id (str, optional) – ID of the scenario the executables should belong to, defaults to None
version_id (str, optional) – ID of the version, the executions should have, defaults to None
resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

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

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse