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

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

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

Methods defined here:
create(self, name: str, data: dict, resource_group: str = None, ai_tenant_scope=True) -> ai_core_sdk.models.base_models.Message
Creates a secret.
 
:param name: name of the secret
:type name: str
:param data: data of secret
:type data: dict
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
    defaults to None
:type resource_group: str
:param ai_tenant_scope: Specify whether the main tenant scope is to be used
:type ai_tenant_scope: bool
: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.AIAPIForbiddenException` if a 403 response is received from the
    server
:raises: class:`ai_api_client_sdk.exception.AIAPIConflictException` if a 409 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 available secrets
:rtype: class:`ai_core_sdk.models.base_models.Message`
delete(self, name: str, resource_group: str = None, ai_tenant_scope=True) -> ai_core_sdk.models.base_models.Message
Deletes the secret.
 
:param name: name of the secret to be deleted
:type name: 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_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
    defaults to None
:type resource_group: str
:param ai_tenant_scope: Specify whether the main tenant scope is to be used
:type ai_tenant_scope: bool
: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.AIAPIForbiddenException` if a 403 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.Message`
modify(self, name: str, data: dict, resource_group: str = None, ai_tenant_scope=True) -> ai_core_sdk.models.base_models.Message
Modifies the secret.
 
:param name: name of the secret to be modified
:type name: str
:param data: data of secret
:type data: dict
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
    defaults to None
:type resource_group: str
:param ai_tenant_scope: Specify whether the main tenant scope is to be used
:type ai_tenant_scope: bool
: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.AIAPIForbiddenException` if a 403 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.Message`
query(self, top: int = None, skip: int = None, resource_group: str = None, ai_tenant_scope: bool = True) -> ai_core_sdk.models.secret_query_response.SecretQueryResponse
Returns the secrets.
 
:param top: Number of secrets to be retrieved, defaults to None
:type top: int, optional
:param skip: Number of secrets to be skipped, from the list of the queried secrets, 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_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
    defaults to None
:type resource_group: str
:param ai_tenant_scope: Specify whether the main tenant scope is to be used
:type ai_tenant_scope: bool
: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.AIAPIForbiddenException` if a 403 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 secrets
:rtype: class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`

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
get(self, *args, **kwargs)
Retrieves 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)