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

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

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

Methods defined here:
create(self, name: str, data: dict) -> ai_core_sdk.models.base_models.Message
Creates a docker secret based on the configuration in the request body.
 
:param name: name of the docker registry secret
:type name: str
:param data: json dict, defining the docker registry secret
:type data: dict
: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.Message`
delete(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the docker registry secret with the given name if it exists.
 
:param name: name of the docker registry secret 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.docker_registry_secret.DockerRegistrySecret
Returns the metadata of the docker registry secrets which matches the given name.
 
:param name: name of the docker registry secret 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 retrieved metadata of the docker registry secret
:rtype: class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`
modify(self, name: str, data: dict) -> ai_api_client_sdk.models.base_models.BasicResponse
Updates the docker registry secret
 
:param name: name of the docker registry secret to be modified
:type name: str
:param data: json dict, defining the docker registry secret
:type data: dict
: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, top: int = None, skip: int = None) -> ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse
Gets a list of metadata of docker registry secrets.
 
:param top: Number of docker registry secrets to be retrieved, defaults to None
:type top: int, optional
:param skip: Number of docker registry secrets to be skipped, from the list of the queried docker registry
    secrets, defaults to None
:type skip: int, 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: A list of metadata of secrets
:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`

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)