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

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

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

Methods defined here:
create(self, name: str, type: str, data: dict, bucket: str = None, endpoint: str = None, region: str = None, path_prefix: str = None, verifyssl: str = None, usehttps: str = None, resource_group: str = None) -> ai_core_sdk.models.base_models.Message
Creates an object store secret.
 
:param name: name of the object store secret
:type name: str
:param type: type of object storage
:type type: str
:param data: data to be posted
:type data: str
:param bucket: name of the bucket
:type bucket: str
:param endpoint: endpoint of object storage
:type endpoint: str
:param region: region of object storage
:type region: str
:param path_prefix: path prefix
:type path_prefix: str
:param verifyssl: verify ssl
:type verifyssl: str
:param usehttps: use https
:type usehttps: 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
: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
:return: A list of metadata of available secrets
:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
delete(self, name: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the object store secret.
 
:param name: name of the object store 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
: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
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
get(self, name: str, resource_group: str = None) -> ai_core_sdk.models.object_store_secret.ObjectStoreSecret
Retrieves the object store secret from the server.
 
:param name: name of the object store secret to be retrieved
: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
: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
:return: The retrieved object store secret
:rtype: class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`
modify(self, name: str, type: str, data: dict, bucket: str = None, endpoint: str = None, region: str = None, path_prefix: str = None, verifyssl: str = None, usehttps: str = None, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the object store secret
 
:param name: name of the object store secret to be modified
:type name: str
:param type: type of object storage
:type type: str
:param data: data to be posted
:type data: str
:param bucket: name of the bucket
:type bucket: str
:param endpoint: endpoint of object storage
:type endpoint: str
:param region: region of object storage
:type region: str
:param path_prefix: path prefix
:type path_prefix: str
:param verifyssl: verify ssl
:type verifyssl: str
:param usehttps: use https
:type usehttps: 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
: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
: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, resource_group: str = None) -> ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse
Returns the object store secrets.
 
:param top: Number of object store secrets to be retrieved, defaults to None
:type top: int, optional
:param skip: Number of object store secrets to be skipped, from the list of the queried object store
    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
: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
:return: A list of object store secrets
:rtype: class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`

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)