Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
567 changes: 567 additions & 0 deletions gooddata-api-client/docs/AIAgentsApi.md

Large diffs are not rendered by default.

313 changes: 313 additions & 0 deletions gooddata-api-client/docs/AILakeDatabasesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
# gooddata_api_client.AILakeDatabasesApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**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
[**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
[**list_ai_lake_database_instances**](AILakeDatabasesApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances
[**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


# **deprovision_ai_lake_database_instance**
> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} deprovision_ai_lake_database_instance(instance_id)

(BETA) Delete an existing AILake Database instance

(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.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import ai_lake_databases_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client)
instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID.
operation_id = "operation-id_example" # str | (optional)

# example passing only required values which don't have defaults set
try:
# (BETA) Delete an existing AILake Database instance
api_response = api_instance.deprovision_ai_lake_database_instance(instance_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# (BETA) Delete an existing AILake Database instance
api_response = api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. |
**operation_id** | **str**| | [optional]

### Return type

**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Accepted | * operation-id - Operation ID to use for polling. <br> * operation-location - Operation location URL that can be used for polling. <br> |

[[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)

# **get_ai_lake_database_instance**
> DatabaseInstance get_ai_lake_database_instance(instance_id)

(BETA) Get the specified AILake Database instance

(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import ai_lake_databases_api
from gooddata_api_client.model.database_instance import DatabaseInstance
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client)
instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID.

# example passing only required values which don't have defaults set
try:
# (BETA) Get the specified AILake Database instance
api_response = api_instance.get_ai_lake_database_instance(instance_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AILakeDatabasesApi->get_ai_lake_database_instance: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. |

### Return type

[**DatabaseInstance**](DatabaseInstance.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | AI Lake database instance successfully retrieved | - |

[[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)

# **list_ai_lake_database_instances**
> ListDatabaseInstancesResponse list_ai_lake_database_instances()

(BETA) List AI Lake Database instances

(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.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import ai_lake_databases_api
from gooddata_api_client.model.list_database_instances_response import ListDatabaseInstancesResponse
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client)
size = 50 # int | (optional) if omitted the server will use the default value of 50
offset = 0 # int | (optional) if omitted the server will use the default value of 0
meta_include = [
"metaInclude_example",
] # [str] | (optional)

# example passing only required values which don't have defaults set
# and optional values
try:
# (BETA) List AI Lake Database instances
api_response = api_instance.list_ai_lake_database_instances(size=size, offset=offset, meta_include=meta_include)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AILakeDatabasesApi->list_ai_lake_database_instances: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**size** | **int**| | [optional] if omitted the server will use the default value of 50
**offset** | **int**| | [optional] if omitted the server will use the default value of 0
**meta_include** | **[str]**| | [optional]

### Return type

[**ListDatabaseInstancesResponse**](ListDatabaseInstancesResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | AI Lake database instances successfully retrieved | - |

[[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)

# **provision_ai_lake_database_instance**
> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} provision_ai_lake_database_instance(provision_database_instance_request)

(BETA) Create a new AILake Database instance

(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.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import ai_lake_databases_api
from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client)
provision_database_instance_request = ProvisionDatabaseInstanceRequest(
name="name_example",
storage_ids=[
"storage_ids_example",
],
) # ProvisionDatabaseInstanceRequest |
operation_id = "operation-id_example" # str | (optional)

# example passing only required values which don't have defaults set
try:
# (BETA) Create a new AILake Database instance
api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AILakeDatabasesApi->provision_ai_lake_database_instance: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# (BETA) Create a new AILake Database instance
api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request, operation_id=operation_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling AILakeDatabasesApi->provision_ai_lake_database_instance: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**provision_database_instance_request** | [**ProvisionDatabaseInstanceRequest**](ProvisionDatabaseInstanceRequest.md)| |
**operation_id** | **str**| | [optional]

### Return type

**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Accepted | * operation-id - Operation ID to use for polling. <br> * operation-location - Operation location URL that can be used for polling. <br> |

[[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)

Loading
Loading