ai_core_sdk.resource_clients.repositories_client
index
/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/repositories_client.py

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

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

Methods defined here:
create(self, name: str, url: str, username: str, password: str) -> ai_core_sdk.models.base_models.Message
On-boards a new GitOps repository
 
:param name: name of the GitOps repository
:type name: str
:param url: url of the GitOps repository
:type url: str
:param username: username to the GitOps repository
:type username: str
:param password: password to the GitOps repository
:type password: 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_core_sdk.models.base_models.BasicNameResponse`
delete(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Off-boards a GitOps repository.
 
:param name: name of the repository to be deleted
:type 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, name: str) -> ai_core_sdk.models.repository.Repository
Retrieves the access details for a repository if it exists.
 
:param name: name of the repository to be retrieved
:type 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 access details for a repository
:rtype: class:`ai_core_client_sdk.models.docker_registry_secret.DockerRegistrySecret`
modify(self, name: str, username: str, password: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Updates the referenced repository credentials to synchronize repository.
 
:param name: name of the repository to be modified
:type name: str
:param username: username to the repository
:type username: str
:param password: password to the repository
:type password: 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.repository_query_response.RepositoryQueryResponse
Retrieves a list of all GitOps repositories for a tenant.
 
: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: A list all GitOps repositories for a tenant
:rtype: class:`ai_core_client_sdk.models.repository_query_response.RepositoryQueryResponse`

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
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)