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

 
Modules
       
re

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

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

Methods defined here:
bulk_modify(self, deployments: List[ai_api_client_sdk.models.base_models.BasicModifyRequest], resource_group: str = None) -> ai_api_client_sdk.models.deployment_bulk_modify_response.DeploymentBulkModifyResponse
Modifies the deployments
:param deployments: List of deployment modify requests
:type deployments: List[DeploymentModifyRequest]
: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.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.deployment_bulk_modify_response.DeploymentBulkModifyResponse`
count(self, scenario_id: str = None, configuration_id: str = None, executable_ids: List[str] = None, status: ai_api_client_sdk.models.status.Status = None, resource_group: str = None) -> int
Counts the number of deployments.
 
:param scenario_id: ID of the scenario, the deployments should belong to, defaults to None
:type scenario_id: str, optional
:param configuration_id: ID of the configuration, the deployments should be configured by, defaults to None
:type configuration_id: str, optional
:param executable_ids: IDs of the executables, the deployments should be created from, defaults to None
:type executable_ids: List[str], optional
:param status: Status which the deployments 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
: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, configuration_id: str, ttl: str = None, resource_group: str = None) -> ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse
Creates a deployment.
 
:param configuration_id: ID of the configuration, that should configure the deployment
:type configuration_id: str
:param ttl: Time to live for deployment and can be none or take  a number followed by the unit
(any of following values, minutes(m|M), hours(h|H) or days(d|D))
:type ttl: 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
: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.deployment_create_response.DeploymentCreateResponse`
delete(self, deployment_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the deployment.
 
:param deployment_id: ID of the deployment to be deleted
:type deployment_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, deployment_id: str, resource_group: str = None, select: str = None) -> Union[ai_api_client_sdk.models.deployment.Deployment, ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse]
Retrieves the deployment from the server.
 
:param deployment_id: ID of the deployment to be retrieved
:type deployment_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 deployment for a given deployment 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
: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 deployment
:rtype: class:Union[`ai_api_client_sdk.models.deployment.Deployment`,
    `ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse`]
modify(self, deployment_id: str, target_status: ai_api_client_sdk.models.target_status.TargetStatus = None, configuration_id: str = None, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the deployment, by changing either the target status, or the configuration ID.
 
:param deployment_id: ID of the deployment to be modified
:type deployment_id: str
:param target_status: Desired target status of the deployment, defaults to None
:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`, optional
:param configuration_id: ID of the new configuration to be used by the deployment, defaults to None
:type configuration_id: 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.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.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, scenario_id: str = None, configuration_id: str = None, executable_ids: List[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.deployment_query_response.DeploymentQueryResponse
Queries the deployments.
 
:param scenario_id: ID of the scenario the deployments should belong to, defaults to None
:type scenario_id: str, optional
:param configuration_id: ID of the configuration, the deployments should be configured by, defaults to None
:type configuration_id: str, optional
:param executable_ids: IDs of the executables the deployments should be created from, defaults to None
:type executable_ids: List[str], optional
:param status: Status which the deployments should currently have
:type status: class:`ai_api_client_sdk.models.status.Status`, optional
:param top: Number of deployments to be retrieved, defaults to None
:type top: int, optional
:param skip: Number of deployments to be skipped, from the list of the queried deployments, 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.deployment_query_response.DeploymentQueryResponse`
query_logs(self, deployment_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 deployment.
 
:param deployment_id: ID of the deployment
:type deployment_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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
    trying to send a request to 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