ai_core_sdk.resource_clients.applications_client
index
/data/jenkins/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/applications_client.py

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

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

Methods defined here:
create(self, revision: str, path: str, application_name: str = None, repository_name: str = None, repository_url: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Creates an application.
 
:param revision: revision to synchronize
:type revision: str
:param path: within the repository to synchronize
:type path: str
:param application_name: Name of the application
:type application_name: str, optional
:param repository_name: Name of the repository to synchronize. Either this or the repository_url needs to be
    provided
:type repository_name: str, optional
:param repository_url: URL of the repository to synchronize. Either this or the repository_name needs to be
    provided
:type repository_url: 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.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`
delete(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the application.
 
:param application_name: name of the application to be deleted
:type application_name: 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, application_name: str) -> ai_core_sdk.models.application.Application
Retrieves the application from the server.
 
:param application_name: name of the application to be retrieved
:type application_name: 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 application
:rtype: class:`ai_core_sdk.models.application.Application`
get_status(self, application_name: str) -> ai_core_sdk.models.application_status.ApplicationStatus
Retrieves the application status from the server.
 
:param application_name: name of the application
:type application_name: 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 application status
:rtype: class:`ai_core_sdk.models.application_status.ApplicationStatus`
modify(self, application_name: str, repository_url: str, path: str, revision: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the application
 
:param application_name: name of the application to be modified
:type name: str
:param repository_url:
:type repository_url: str
:param revision:
:type revision: str
:param path:
:type path: 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) -> ai_core_sdk.models.application_query_response.ApplicationQueryResponse
Returns the applications.
 
: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: The retrieved applications
:rtype: class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`

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.
count(self, *args, **kwargs)
Counts the relevant resources. 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)