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

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

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

Methods defined here:
create(self, resource_group_id: str, labels: List[ai_api_client_sdk.models.label.Label] = None) -> ai_core_sdk.models.resource_group.ResourceGroup
Creates resource group for a given tenant.
 
:param resource_group_id: the id of the resource group and the length must be between 3 and 10 characters.
:type resource_group_id: str
:param labels: key-value pairs of the labels that will be added to the resource group.
:type labels: List[Label]
: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.resource_group.ResourceGroup`
delete(self, resource_group_id: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the resource group.
 
:param resource_group_id: the id of the resource group to be deleted
:type resource_group_id: 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, resource_group_id: str) -> ai_core_sdk.models.resource_group.ResourceGroup
Gets a resource group of a given tenant.
 
:param resource_group_id: the id of the resource group to be retrieved
:type resource_group_id: 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: An object representing the resource group from the server
:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
modify(self, resource_group_id: str, labels: List[ai_api_client_sdk.models.label.Label]) -> None
Modifies a resource group.
 
:param resource_group_id: the id of the resource group
:type resource_group_id: str
:param labels: key-value pairs of the labels that will be added to the resource group.
:type labels: List[Label]
: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
query(self) -> ai_core_sdk.models.resource_group_query_response.ResourceGroupQueryResponse
Get all resource groups.
 
: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 resource groups for a given tenant.
:rtype: class:`ai_core_sdk.models.resource_group_query_response.ResourceGroupQueryResponse`

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)

 
Data
        List = typing.List