Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and Android. Generated with openapi-generator kotlin (library=jvm-okhttp4, useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai. Co-authored-by: Hanzo Dev <[email protected]>
7.7 KiB
DatabasesApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| dbCreateDatabase | POST /v1/db/projects/{id}/databases | Create database |
| dbDeleteDatabase | DELETE /v1/db/projects/{id}/databases/{name} | Delete database |
| dbGetDatabase | GET /v1/db/projects/{id}/databases/{name} | Get database |
| dbListDatabases | GET /v1/db/projects/{id}/databases | List databases |
| dbUpdateDatabase | PUT /v1/db/projects/{id}/databases/{name} | Update database |
dbCreateDatabase
DbCreateDatabase201Response dbCreateDatabase(id, dbCreateDatabaseRequest)
Create database
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DatabasesApi()
val id : kotlin.String = id_example // kotlin.String |
val dbCreateDatabaseRequest : DbCreateDatabaseRequest = // DbCreateDatabaseRequest |
try {
val result : DbCreateDatabase201Response = apiInstance.dbCreateDatabase(id, dbCreateDatabaseRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DatabasesApi#dbCreateDatabase")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DatabasesApi#dbCreateDatabase")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| dbCreateDatabaseRequest | DbCreateDatabaseRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
dbDeleteDatabase
DbCreateDatabase201Response dbDeleteDatabase(id, name, branchId)
Delete database
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DatabasesApi()
val id : kotlin.String = id_example // kotlin.String |
val name : kotlin.String = name_example // kotlin.String |
val branchId : kotlin.String = branchId_example // kotlin.String |
try {
val result : DbCreateDatabase201Response = apiInstance.dbDeleteDatabase(id, name, branchId)
println(result)
} catch (e: ClientException) {
println("4xx response calling DatabasesApi#dbDeleteDatabase")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DatabasesApi#dbDeleteDatabase")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | | | name | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| branchId | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
dbGetDatabase
DbCreateDatabase201Response dbGetDatabase(id, name, branchId)
Get database
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DatabasesApi()
val id : kotlin.String = id_example // kotlin.String |
val name : kotlin.String = name_example // kotlin.String |
val branchId : kotlin.String = branchId_example // kotlin.String |
try {
val result : DbCreateDatabase201Response = apiInstance.dbGetDatabase(id, name, branchId)
println(result)
} catch (e: ClientException) {
println("4xx response calling DatabasesApi#dbGetDatabase")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DatabasesApi#dbGetDatabase")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | | | name | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| branchId | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
dbListDatabases
DbListDatabases200Response dbListDatabases(id, branchId)
List databases
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DatabasesApi()
val id : kotlin.String = id_example // kotlin.String |
val branchId : kotlin.String = branchId_example // kotlin.String |
try {
val result : DbListDatabases200Response = apiInstance.dbListDatabases(id, branchId)
println(result)
} catch (e: ClientException) {
println("4xx response calling DatabasesApi#dbListDatabases")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DatabasesApi#dbListDatabases")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| branchId | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
dbUpdateDatabase
DbCreateDatabase201Response dbUpdateDatabase(id, name, dbUpdateDatabaseRequest)
Update database
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DatabasesApi()
val id : kotlin.String = id_example // kotlin.String |
val name : kotlin.String = name_example // kotlin.String |
val dbUpdateDatabaseRequest : DbUpdateDatabaseRequest = // DbUpdateDatabaseRequest |
try {
val result : DbCreateDatabase201Response = apiInstance.dbUpdateDatabase(id, name, dbUpdateDatabaseRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling DatabasesApi#dbUpdateDatabase")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DatabasesApi#dbUpdateDatabase")
e.printStackTrace()
}
Parameters
| id | kotlin.String| | | | name | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| dbUpdateDatabaseRequest | DbUpdateDatabaseRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json