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]>
5.8 KiB
KvApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| provisioningCreateKv | POST /v1/kv | Provision a key-value resource |
| provisioningDeleteKv | DELETE /v1/kv/{name} | Deprovision a key-value resource |
| provisioningGetKv | GET /v1/kv/{name} | Get one key-value resource |
| provisioningListKv | GET /v1/kv | List key-value resources for the caller's org |
provisioningCreateKv
ProvisioningCreateResponse provisioningCreateKv(provisioningCreateRequest)
Provision a key-value resource
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = KvApi()
val provisioningCreateRequest : ProvisioningCreateRequest = // ProvisioningCreateRequest |
try {
val result : ProvisioningCreateResponse = apiInstance.provisioningCreateKv(provisioningCreateRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling KvApi#provisioningCreateKv")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling KvApi#provisioningCreateKv")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| provisioningCreateRequest | ProvisioningCreateRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
provisioningDeleteKv
provisioningDeleteKv(name)
Deprovision a key-value resource
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = KvApi()
val name : kotlin.String = name_example // kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$`.
try {
apiInstance.provisioningDeleteKv(name)
} catch (e: ClientException) {
println("4xx response calling KvApi#provisioningDeleteKv")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling KvApi#provisioningDeleteKv")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^a-z0-9?$`. |
Return type
null (empty response body)
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
provisioningGetKv
ProvisioningGetResponse provisioningGetKv(name)
Get one key-value resource
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = KvApi()
val name : kotlin.String = name_example // kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$`.
try {
val result : ProvisioningGetResponse = apiInstance.provisioningGetKv(name)
println(result)
} catch (e: ClientException) {
println("4xx response calling KvApi#provisioningGetKv")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling KvApi#provisioningGetKv")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^a-z0-9?$`. |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
provisioningListKv
kotlin.collections.List<ProvisioningListItem> provisioningListKv()
List key-value resources for the caller's org
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = KvApi()
try {
val result : kotlin.collections.List<ProvisioningListItem> = apiInstance.provisioningListKv()
println(result)
} catch (e: ClientException) {
println("4xx response calling KvApi#provisioningListKv")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling KvApi#provisioningListKv")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<ProvisioningListItem>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json