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

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

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

Methods defined here:
bulk_modify(self, executions: List[ai_api_client_sdk.models.base_models.BasicModifyRequest], resource_group: str = None) -> ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse
Modifies the executions
:param executions: List of execution modify requests
:type executions: List[ExecutionModifyRequest]
: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, optional
: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.AIAPIPreconditionFailedException` if a 412 response is received from
    the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse`
count(self, scenario_id: str = None, configuration_id: str = None, executable_ids: List[str] = None, execution_schedule_id: str = None, status: ai_api_client_sdk.models.status.Status = None, resource_group: str = None) -> int
Counts the number of executions.
 
:param scenario_id: ID of the scenario, the executions should belong to, defaults to None
:type scenario_id: str, optional
:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
:type configuration_id: str, optional
:param executable_ids: IDs of the executables, the executions should be created from, defaults to None
:type executable_ids: List[str], optional
:param execution_schedule_id: ID of the execution schedule, defaults to None
:type execution_schedule_id: str, optional
:param status: Status which the executions should currently have
:type status: class:`ai_api_client_sdk.models.status.Status`, 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: int
create(self, configuration_id: str, resource_group: str = None) -> ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse
Creates an execution.
 
:param configuration_id: ID of the configuration, that should configure the execution
:type configuration_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.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.execution_create_response.ExecutionCreateResponse`
delete(self, execution_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the execution.
 
:param execution_id: ID of the execution to 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.AIAPIPreconditionFailedException` if a 412 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.base_models.BasicResponse`
get(self, execution_id: str, resource_group: str = None, select: str = None) -> Union[ai_api_client_sdk.models.execution.Execution, ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse]
Retrieves the execution from the server.
 
:param execution_id: ID of the execution to be retrieved
: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
:param select: only status supported. Get execution for a given execution id and select status
:type select: str, optional
: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
:return: The retrieved execution
:rtype: class:Union[`ai_api_client_sdk.models.execution.Execution`,
    `ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse`]
modify(self, execution_id: str, target_status: ai_api_client_sdk.models.target_status.TargetStatus, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the execution, by changing the target status.
 
:param execution_id: ID of the execution to be modified
:type execution_id: str
:param target_status: Desired target status of the execution, defaults to None
:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`, 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.AIAPINotFoundException` if a 404 response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 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.base_models.BasicResponse`
query(self, scenario_id: str = None, configuration_id: str = None, executable_ids: List[str] = None, execution_schedule_id: str = None, status: ai_api_client_sdk.models.status.Status = None, top: int = None, skip: int = None, resource_group: str = None) -> ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse
Queries the executions.
 
:param scenario_id: ID of the scenario the executions should belong to, defaults to None
:type scenario_id: str, optional
:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
:type configuration_id: str, optional
:param executable_ids: IDs of the executables the executions should be created from, defaults to None
:type executable_ids: List[str], optional
:param execution_schedule_id: ID of the execution schedule, defaults to None
:type execution_schedule_id: str, optional
:param status: Status which the executions should currently have
:type status: class:`ai_api_client_sdk.models.status.Status`, optional
:param top: Number of executions to be retrieved, defaults to None
:type top: int, optional
:param skip: Number of executions to be skipped, from the list of the queried executions, defaults to None
:type skip: int, 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.execution_query_response.ExecutionQueryResponse`
query_logs(self, execution_id: str, top: int = None, start: datetime.datetime = None, end: datetime.datetime = None, order: ai_api_client_sdk.models.base_models.Order = None, resource_group: str = None) -> ai_api_client_sdk.models.log_response.LogResponse
Queries the logs of the execution.
 
:param execution_id: ID of the execution
:type execution_id: str
:param top: The max number of entries to return. Defaults to 1000. Limited to 5000 max.
:type top: int
:param start: The start time for the query. Defaults to one hour ago.
:type start: datetime
:param end: The end time for the query. Defaults to now.
:type end: datetime
:param order: Determines the sort order with respect to time. Defaults to asc.
:type order: class:`ai_api_client_sdk.models.base_models.Order`
: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
:return: Logs from the execution
:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`

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.

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
Union = typing.Union