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

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

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

Methods defined here:
count(self, configuration_id: str = None, status: ai_api_client_sdk.models.status.ScheduleStatus = None, resource_group: str = None) -> int
Counts the number of executions schedules.
 
:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
:type configuration_id: str, optional
:param status: ScheduleStatus which the execution schedule should currently have, defaults to None
:type status: class:`ai_api_client_sdk.models.schedule_status.ScheduleStatus`, 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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
    trying to send a request to the server
:return: An object representing the response from the server
:rtype: int
create(self, name: str, cron: str, configuration_id: str, start: datetime.datetime = None, end: datetime.datetime = None, resource_group: str = None) -> ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse
Creates an execution schedule.
 
:param name: Name of the execution schedule
:type name: str
:param cron: Cron defining the schedule to run the executions
:type name: str
:param configuration_id: ID of the configuration for the execution schedule
:type configuration_id: str
:param start: Start time of the execution schedule in UTC, defaults to None
:type start: datetime, optional
:param end: End time of the execution schedule in UTC e.g., defaults to None
:type end: datetime, 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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
    trying to send a request to the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
delete(self, execution_schedule_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the execution schedule.
 
:param execution_schedule_id: ID of the execution schedule to be deleted
:type execution_schedule_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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
    trying to send a request to the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
get(self, execution_schedule_id: str, resource_group: str = None) -> ai_api_client_sdk.models.execution_schedule.ExecutionSchedule
Retrieves the execution schedule from the server.
 
:param execution_schedule_id: ID of the execution schedule to be retrieved
:type execution_schedule_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
: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 execution
:rtype: class:`ai_api_client_sdk.models.execution.Execution`
modify(self, execution_schedule_id: str, cron: str = None, start: datetime.datetime = None, end: datetime.datetime = None, configurationId: str = None, status: ai_api_client_sdk.models.status.ScheduleStatus = None, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the execution schedule.
 
:param execution_schedule_id: ID of the execution to be modified
:type execution_schedule_id: str
:param cron: Cron defining the schedule to run the executions, defaults to None
:type cron: str, optional
:param configurationId: ID of the configuration for the execution schedule, defaults to None
:type configurationId: str, optional
:param start: Start time of the execution schedule in UTC, defaults to None
:type start: datetime, optional
:param end: End time of the execution schedule in UTC, defaults to None
:type end: datetime, optional
:param status: pause / resume Status of the execution schedule, defaults to None
:type status: class:`ai_api_client_sdk.models.status.ScheduleStatus`, 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.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: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
query(self, configuration_id: str = None, status: ai_api_client_sdk.models.status.ScheduleStatus = None, top: int = None, skip: int = None, resource_group: str = None) -> ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse
Queries the execution schedules.
 
:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
:type configuration_id: str, optional
:param status:  ScheduleStatus which the execution schedule should currently have
:type status: class:`ai_api_client_sdk.models.schedule_status.ScheduleStatus`, 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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
    trying to send a request to the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`

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
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
        DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'