braincube
Braincube
Braincube object that handles the feature of a braincube.
__init__(self, product_id, name, metadata)
special
Initialize Braincube.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
product_id |
str |
Braincube unique identifier. |
required |
name |
str |
Braincube name. |
required |
metadata |
Dict[str, Any] |
Raw metadata associated to the Braincube. |
required |
get_memory_base(self, mb_bcid)
Get a MemoryBase object from its id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mb_bcid |
Union[str, int] |
Memory bases bcid. |
required |
Returns:
| Type | Description |
|---|---|
MemoryBase |
The selected MemoryBase object. |
get_memory_base_list(self, **kwargs)
Get a list of the memory bases available in the braincube.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs |
|
Optional page and page_size. |
{} |
Returns:
| Type | Description |
|---|---|
List[braincube_connector.memory_base.memory_base.MemoryBase] |
A list of the MemoryBase objects. |
get_uuid(self)
Get uuid (specific for a braincube entity).
Returns:
| Type | Description |
|---|---|
|
The braincube uuid. |
get_braincube(name)
Get a braincube object from its name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name |
str |
Name of the selected braincube. |
required |
Returns:
| Type | Description |
|---|---|
Braincube |
The selected Braincube object. |
get_braincube_list(names=None)
Get a list of available memory bases in the braincube.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
names |
List[str] |
List of braincube names to return. |
None |
Returns:
| Type | Description |
|---|---|
List[braincube_connector.braincube.Braincube] |
List of the Braincube objects. |