|
| 1 | +# gooddata_api_client.AILakeDatabasesApi |
| 2 | + |
| 3 | +All URIs are relative to *http://localhost* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**deprovision_ai_lake_database_instance**](AILakeDatabasesApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance |
| 8 | +[**get_ai_lake_database_instance**](AILakeDatabasesApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance |
| 9 | +[**list_ai_lake_database_instances**](AILakeDatabasesApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances |
| 10 | +[**provision_ai_lake_database_instance**](AILakeDatabasesApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance |
| 11 | + |
| 12 | + |
| 13 | +# **deprovision_ai_lake_database_instance** |
| 14 | +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} deprovision_ai_lake_database_instance(instance_id) |
| 15 | +
|
| 16 | +(BETA) Delete an existing AILake Database instance |
| 17 | + |
| 18 | +(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress. |
| 19 | + |
| 20 | +### Example |
| 21 | + |
| 22 | + |
| 23 | +```python |
| 24 | +import time |
| 25 | +import gooddata_api_client |
| 26 | +from gooddata_api_client.api import ai_lake_databases_api |
| 27 | +from pprint import pprint |
| 28 | +# Defining the host is optional and defaults to http://localhost |
| 29 | +# See configuration.py for a list of all supported configuration parameters. |
| 30 | +configuration = gooddata_api_client.Configuration( |
| 31 | + host = "http://localhost" |
| 32 | +) |
| 33 | + |
| 34 | + |
| 35 | +# Enter a context with an instance of the API client |
| 36 | +with gooddata_api_client.ApiClient() as api_client: |
| 37 | + # Create an instance of the API class |
| 38 | + api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) |
| 39 | + instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. |
| 40 | + operation_id = "operation-id_example" # str | (optional) |
| 41 | + |
| 42 | + # example passing only required values which don't have defaults set |
| 43 | + try: |
| 44 | + # (BETA) Delete an existing AILake Database instance |
| 45 | + api_response = api_instance.deprovision_ai_lake_database_instance(instance_id) |
| 46 | + pprint(api_response) |
| 47 | + except gooddata_api_client.ApiException as e: |
| 48 | + print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e) |
| 49 | + |
| 50 | + # example passing only required values which don't have defaults set |
| 51 | + # and optional values |
| 52 | + try: |
| 53 | + # (BETA) Delete an existing AILake Database instance |
| 54 | + api_response = api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) |
| 55 | + pprint(api_response) |
| 56 | + except gooddata_api_client.ApiException as e: |
| 57 | + print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e) |
| 58 | +``` |
| 59 | + |
| 60 | + |
| 61 | +### Parameters |
| 62 | + |
| 63 | +Name | Type | Description | Notes |
| 64 | +------------- | ------------- | ------------- | ------------- |
| 65 | + **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | |
| 66 | + **operation_id** | **str**| | [optional] |
| 67 | + |
| 68 | +### Return type |
| 69 | + |
| 70 | +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** |
| 71 | + |
| 72 | +### Authorization |
| 73 | + |
| 74 | +No authorization required |
| 75 | + |
| 76 | +### HTTP request headers |
| 77 | + |
| 78 | + - **Content-Type**: Not defined |
| 79 | + - **Accept**: application/json |
| 80 | + |
| 81 | + |
| 82 | +### HTTP response details |
| 83 | + |
| 84 | +| Status code | Description | Response headers | |
| 85 | +|-------------|-------------|------------------| |
| 86 | +**202** | Accepted | * operation-id - Operation ID to use for polling. <br> * operation-location - Operation location URL that can be used for polling. <br> | |
| 87 | + |
| 88 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 89 | + |
| 90 | +# **get_ai_lake_database_instance** |
| 91 | +> DatabaseInstance get_ai_lake_database_instance(instance_id) |
| 92 | +
|
| 93 | +(BETA) Get the specified AILake Database instance |
| 94 | + |
| 95 | +(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake. |
| 96 | + |
| 97 | +### Example |
| 98 | + |
| 99 | + |
| 100 | +```python |
| 101 | +import time |
| 102 | +import gooddata_api_client |
| 103 | +from gooddata_api_client.api import ai_lake_databases_api |
| 104 | +from gooddata_api_client.model.database_instance import DatabaseInstance |
| 105 | +from pprint import pprint |
| 106 | +# Defining the host is optional and defaults to http://localhost |
| 107 | +# See configuration.py for a list of all supported configuration parameters. |
| 108 | +configuration = gooddata_api_client.Configuration( |
| 109 | + host = "http://localhost" |
| 110 | +) |
| 111 | + |
| 112 | + |
| 113 | +# Enter a context with an instance of the API client |
| 114 | +with gooddata_api_client.ApiClient() as api_client: |
| 115 | + # Create an instance of the API class |
| 116 | + api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) |
| 117 | + instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. |
| 118 | + |
| 119 | + # example passing only required values which don't have defaults set |
| 120 | + try: |
| 121 | + # (BETA) Get the specified AILake Database instance |
| 122 | + api_response = api_instance.get_ai_lake_database_instance(instance_id) |
| 123 | + pprint(api_response) |
| 124 | + except gooddata_api_client.ApiException as e: |
| 125 | + print("Exception when calling AILakeDatabasesApi->get_ai_lake_database_instance: %s\n" % e) |
| 126 | +``` |
| 127 | + |
| 128 | + |
| 129 | +### Parameters |
| 130 | + |
| 131 | +Name | Type | Description | Notes |
| 132 | +------------- | ------------- | ------------- | ------------- |
| 133 | + **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | |
| 134 | + |
| 135 | +### Return type |
| 136 | + |
| 137 | +[**DatabaseInstance**](DatabaseInstance.md) |
| 138 | + |
| 139 | +### Authorization |
| 140 | + |
| 141 | +No authorization required |
| 142 | + |
| 143 | +### HTTP request headers |
| 144 | + |
| 145 | + - **Content-Type**: Not defined |
| 146 | + - **Accept**: application/json |
| 147 | + |
| 148 | + |
| 149 | +### HTTP response details |
| 150 | + |
| 151 | +| Status code | Description | Response headers | |
| 152 | +|-------------|-------------|------------------| |
| 153 | +**200** | AI Lake database instance successfully retrieved | - | |
| 154 | + |
| 155 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 156 | + |
| 157 | +# **list_ai_lake_database_instances** |
| 158 | +> ListDatabaseInstancesResponse list_ai_lake_database_instances() |
| 159 | +
|
| 160 | +(BETA) List AI Lake Database instances |
| 161 | + |
| 162 | +(BETA) Lists database instances in the organization's AI Lake. Supports paging via size and offset query parameters. Use metaInclude=page to get total count. |
| 163 | + |
| 164 | +### Example |
| 165 | + |
| 166 | + |
| 167 | +```python |
| 168 | +import time |
| 169 | +import gooddata_api_client |
| 170 | +from gooddata_api_client.api import ai_lake_databases_api |
| 171 | +from gooddata_api_client.model.list_database_instances_response import ListDatabaseInstancesResponse |
| 172 | +from pprint import pprint |
| 173 | +# Defining the host is optional and defaults to http://localhost |
| 174 | +# See configuration.py for a list of all supported configuration parameters. |
| 175 | +configuration = gooddata_api_client.Configuration( |
| 176 | + host = "http://localhost" |
| 177 | +) |
| 178 | + |
| 179 | + |
| 180 | +# Enter a context with an instance of the API client |
| 181 | +with gooddata_api_client.ApiClient() as api_client: |
| 182 | + # Create an instance of the API class |
| 183 | + api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) |
| 184 | + size = 50 # int | (optional) if omitted the server will use the default value of 50 |
| 185 | + offset = 0 # int | (optional) if omitted the server will use the default value of 0 |
| 186 | + meta_include = [ |
| 187 | + "metaInclude_example", |
| 188 | + ] # [str] | (optional) |
| 189 | + |
| 190 | + # example passing only required values which don't have defaults set |
| 191 | + # and optional values |
| 192 | + try: |
| 193 | + # (BETA) List AI Lake Database instances |
| 194 | + api_response = api_instance.list_ai_lake_database_instances(size=size, offset=offset, meta_include=meta_include) |
| 195 | + pprint(api_response) |
| 196 | + except gooddata_api_client.ApiException as e: |
| 197 | + print("Exception when calling AILakeDatabasesApi->list_ai_lake_database_instances: %s\n" % e) |
| 198 | +``` |
| 199 | + |
| 200 | + |
| 201 | +### Parameters |
| 202 | + |
| 203 | +Name | Type | Description | Notes |
| 204 | +------------- | ------------- | ------------- | ------------- |
| 205 | + **size** | **int**| | [optional] if omitted the server will use the default value of 50 |
| 206 | + **offset** | **int**| | [optional] if omitted the server will use the default value of 0 |
| 207 | + **meta_include** | **[str]**| | [optional] |
| 208 | + |
| 209 | +### Return type |
| 210 | + |
| 211 | +[**ListDatabaseInstancesResponse**](ListDatabaseInstancesResponse.md) |
| 212 | + |
| 213 | +### Authorization |
| 214 | + |
| 215 | +No authorization required |
| 216 | + |
| 217 | +### HTTP request headers |
| 218 | + |
| 219 | + - **Content-Type**: Not defined |
| 220 | + - **Accept**: application/json |
| 221 | + |
| 222 | + |
| 223 | +### HTTP response details |
| 224 | + |
| 225 | +| Status code | Description | Response headers | |
| 226 | +|-------------|-------------|------------------| |
| 227 | +**200** | AI Lake database instances successfully retrieved | - | |
| 228 | + |
| 229 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 230 | + |
| 231 | +# **provision_ai_lake_database_instance** |
| 232 | +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} provision_ai_lake_database_instance(provision_database_instance_request) |
| 233 | +
|
| 234 | +(BETA) Create a new AILake Database instance |
| 235 | + |
| 236 | +(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress. |
| 237 | + |
| 238 | +### Example |
| 239 | + |
| 240 | + |
| 241 | +```python |
| 242 | +import time |
| 243 | +import gooddata_api_client |
| 244 | +from gooddata_api_client.api import ai_lake_databases_api |
| 245 | +from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest |
| 246 | +from pprint import pprint |
| 247 | +# Defining the host is optional and defaults to http://localhost |
| 248 | +# See configuration.py for a list of all supported configuration parameters. |
| 249 | +configuration = gooddata_api_client.Configuration( |
| 250 | + host = "http://localhost" |
| 251 | +) |
| 252 | + |
| 253 | + |
| 254 | +# Enter a context with an instance of the API client |
| 255 | +with gooddata_api_client.ApiClient() as api_client: |
| 256 | + # Create an instance of the API class |
| 257 | + api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) |
| 258 | + provision_database_instance_request = ProvisionDatabaseInstanceRequest( |
| 259 | + name="name_example", |
| 260 | + storage_ids=[ |
| 261 | + "storage_ids_example", |
| 262 | + ], |
| 263 | + ) # ProvisionDatabaseInstanceRequest | |
| 264 | + operation_id = "operation-id_example" # str | (optional) |
| 265 | + |
| 266 | + # example passing only required values which don't have defaults set |
| 267 | + try: |
| 268 | + # (BETA) Create a new AILake Database instance |
| 269 | + api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request) |
| 270 | + pprint(api_response) |
| 271 | + except gooddata_api_client.ApiException as e: |
| 272 | + print("Exception when calling AILakeDatabasesApi->provision_ai_lake_database_instance: %s\n" % e) |
| 273 | + |
| 274 | + # example passing only required values which don't have defaults set |
| 275 | + # and optional values |
| 276 | + try: |
| 277 | + # (BETA) Create a new AILake Database instance |
| 278 | + api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request, operation_id=operation_id) |
| 279 | + pprint(api_response) |
| 280 | + except gooddata_api_client.ApiException as e: |
| 281 | + print("Exception when calling AILakeDatabasesApi->provision_ai_lake_database_instance: %s\n" % e) |
| 282 | +``` |
| 283 | + |
| 284 | + |
| 285 | +### Parameters |
| 286 | + |
| 287 | +Name | Type | Description | Notes |
| 288 | +------------- | ------------- | ------------- | ------------- |
| 289 | + **provision_database_instance_request** | [**ProvisionDatabaseInstanceRequest**](ProvisionDatabaseInstanceRequest.md)| | |
| 290 | + **operation_id** | **str**| | [optional] |
| 291 | + |
| 292 | +### Return type |
| 293 | + |
| 294 | +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** |
| 295 | + |
| 296 | +### Authorization |
| 297 | + |
| 298 | +No authorization required |
| 299 | + |
| 300 | +### HTTP request headers |
| 301 | + |
| 302 | + - **Content-Type**: application/json |
| 303 | + - **Accept**: application/json |
| 304 | + |
| 305 | + |
| 306 | +### HTTP response details |
| 307 | + |
| 308 | +| Status code | Description | Response headers | |
| 309 | +|-------------|-------------|------------------| |
| 310 | +**202** | Accepted | * operation-id - Operation ID to use for polling. <br> * operation-location - Operation location URL that can be used for polling. <br> | |
| 311 | + |
| 312 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 313 | + |
0 commit comments