Files
sdk/include/hanzo/api/ProvisioningApi.h
zeekay 645325a641 regenerate from cloud 939b09d4
The projection was 113 commits behind the document it claims to describe, and
`generate.py --all --check` reported every one of the thirteen clients DRIFTED —
the same +19 models in each, because they all fell behind the same emission.

Regenerated in place from hanzo-inc/cloud openapi.yaml at 939b09d4
(sha256 087024f6…), which is the only description of this API that cannot name a
route the binary does not serve. `--check` is clean across all thirteen after.

.spec-lock moved with the code. The generator READS that file and never writes
it — hanzoai/ci`s lane does — so a hand run leaves every lock naming the previous
document. A lock that disagrees with the tree beside it is worse than no lock:
the next `--check` without `--spec` fetches what production serves, compares it
to a digest that was already wrong, and reports drift that is really staleness.
2026-08-24 23:32:53 -07:00

324 lines
18 KiB
C++

/**
* Hanzo Cloud API
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
*
* The version of the OpenAPI document: v1
*
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/*
* ProvisioningApi.h
*
*
*/
#ifndef HANZO_API_ProvisioningApi_H_
#define HANZO_API_ProvisioningApi_H_
#include "hanzo/ApiClient.h"
#include "hanzo/model/ProvisionRequest.h"
#include "hanzo/model/ProvisionResult.h"
#include "hanzo/model/ProvisionedResource.h"
#include "hanzo/model/ProvisionedSummary.h"
#include <vector>
#include <cpprest/details/basic_types.h>
#include <boost/optional.hpp>
namespace hanzo {
namespace api {
using namespace hanzo::model;
class ProvisioningApi
{
public:
explicit ProvisioningApi( std::shared_ptr<const ApiClient> apiClient );
virtual ~ProvisioningApi();
/// <summary>
/// Deprovisions one Hanzo Datastore warehouse.
/// </summary>
/// <remarks>
/// Deprovisions one Hanzo Datastore warehouse. It reverts any app instance bound to it back to Base BEFORE tearing down the org&#39;s dedicated instance, then deletes the sealed credential and removes the metadata row. Answers 204 with no body; a second call is a 404.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningDatastoreByName(
utility::string_t name
) const;
/// <summary>
/// DropDocDB deprovisions one Hanzo DocDB database.
/// </summary>
/// <remarks>
/// DropDocDB deprovisions one Hanzo DocDB database. It reverts any app instance bound to it back to Base BEFORE tearing down the org&#39;s dedicated FerretDB instance, then deletes the sealed credential and removes the metadata row. Answers 204 with no body; a second call is a 404.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningDocdbByName(
utility::string_t name
) const;
/// <summary>
/// DropKV deprovisions one Hanzo KV store.
/// </summary>
/// <remarks>
/// DropKV deprovisions one Hanzo KV store. It reverts any app instance bound to it back to Base BEFORE tearing down the org&#39;s dedicated Valkey instance, then deletes the sealed credential and removes the metadata row. Answers 204 with no body; a second call is a 404.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningKvByName(
utility::string_t name
) const;
/// <summary>
/// Deletes one bucket from the shared object store and removes its metadata row.
/// </summary>
/// <remarks>
/// Deletes one bucket from the shared object store and removes its metadata row. Answers 204 with no body; a second call is a 404.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningS3ByName(
utility::string_t name
) const;
/// <summary>
/// Deletes one search index from the shared backend and removes its metadata row.
/// </summary>
/// <remarks>
/// Deletes one search index from the shared backend and removes its metadata row. Answers 204 with no body; a second call is a 404.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningSearchByName(
utility::string_t name
) const;
/// <summary>
/// DropSQL deprovisions one Hanzo SQL database.
/// </summary>
/// <remarks>
/// DropSQL deprovisions one Hanzo SQL database. It reverts any app instance bound to it back to Base BEFORE tearing down the org&#39;s dedicated Postgres instance — never a live app pointed at a deleted backend — then deletes the sealed credential and removes the metadata row. Answers 204 with no body; a second call is a 404, not a second delete.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningSqlByName(
utility::string_t name
) const;
/// <summary>
/// Deletes one vector collection from the shared backend and removes its metadata row.
/// </summary>
/// <remarks>
/// Deletes one vector collection from the shared backend and removes its metadata row. Answers 204 with no body; a second call is a 404.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<void> deleteProvisioningVectorByName(
utility::string_t name
) const;
/// <summary>
/// Lists the caller org&#39;s Hanzo Datastore warehouses.
/// </summary>
/// <remarks>
/// Lists the caller org&#39;s Hanzo Datastore warehouses. Each one is a DEDICATED analytical instance the org alone runs, so the host is that instance&#39;s own in-cluster Service and the port is its HTTP port, 8123.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningDatastore(
) const;
/// <summary>
/// Returns one Hanzo Datastore warehouse&#39;s metadata.
/// </summary>
/// <remarks>
/// Returns one Hanzo Datastore warehouse&#39;s metadata. It carries the warehouse&#39;s status, its instance address and the admin user the instance booted with — never the password. A still-booting instance reads \&quot;provisioning\&quot;, reconciled from the operator&#39;s live view rather than the row.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningDatastoreByName(
utility::string_t name
) const;
/// <summary>
/// ListDocDB lists the caller org&#39;s Hanzo DocDB document databases.
/// </summary>
/// <remarks>
/// ListDocDB lists the caller org&#39;s Hanzo DocDB document databases. Each one is a DEDICATED FerretDB instance the org alone runs, speaking the MongoDB wire protocol, so the host is that instance&#39;s own in-cluster Service and the port is 27017.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningDocdb(
) const;
/// <summary>
/// GetDocDB returns one Hanzo DocDB database&#39;s metadata.
/// </summary>
/// <remarks>
/// GetDocDB returns one Hanzo DocDB database&#39;s metadata. It carries the database&#39;s status, its instance address and the SCRAM user the instance was set up with — never the password. A still-booting instance reads \&quot;provisioning\&quot;, reconciled from the operator&#39;s live view.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningDocdbByName(
utility::string_t name
) const;
/// <summary>
/// ListKV lists the caller org&#39;s Hanzo KV stores.
/// </summary>
/// <remarks>
/// ListKV lists the caller org&#39;s Hanzo KV stores. Each one is a DEDICATED Valkey instance the org alone runs, so the host is that instance&#39;s own in-cluster Service and the port is 6379.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningKv(
) const;
/// <summary>
/// GetKV returns one Hanzo KV store&#39;s metadata.
/// </summary>
/// <remarks>
/// GetKV returns one Hanzo KV store&#39;s metadata. It carries the store&#39;s status, its instance address and the Valkey user it authenticates as (\&quot;default\&quot;, the only user a requirepass instance has) — never the password. A still-booting instance reads \&quot;provisioning\&quot;, reconciled from the operator&#39;s live view.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningKvByName(
utility::string_t name
) const;
/// <summary>
/// Lists the caller org&#39;s object-storage buckets.
/// </summary>
/// <remarks>
/// Lists the caller org&#39;s object-storage buckets. A bucket lives in an already-live shared object store and is reached through the public gateway. The names here are the friendly ones the org provisioned; the physical bucket is org-namespaced underneath, which is what keeps two tenants&#39; buckets distinct.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningS3(
) const;
/// <summary>
/// Returns one bucket&#39;s metadata.
/// </summary>
/// <remarks>
/// Returns one bucket&#39;s metadata. It carries the bucket&#39;s status and the gateway address it is reached at, and no username: the object store authenticates with a shared, out-of-band key rather than a per-bucket credential.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningS3ByName(
utility::string_t name
) const;
/// <summary>
/// Lists the caller org&#39;s search indexes.
/// </summary>
/// <remarks>
/// Lists the caller org&#39;s search indexes. An index is a logical resource inside an already-live shared backend, so every one of them is reached through the public gateway rather than at an instance of its own.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningSearch(
) const;
/// <summary>
/// Returns one search index&#39;s metadata.
/// </summary>
/// <remarks>
/// Returns one search index&#39;s metadata. It carries the index&#39;s status and the gateway address it is reached at, and no username: the backend authenticates with a shared, out-of-band key rather than a per-index credential.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningSearchByName(
utility::string_t name
) const;
/// <summary>
/// ListSQL lists the caller org&#39;s Hanzo SQL databases.
/// </summary>
/// <remarks>
/// ListSQL lists the caller org&#39;s Hanzo SQL databases. Each one is a DEDICATED PostgreSQL instance the org alone runs, so the host is that instance&#39;s own in-cluster Service and the port is 5432.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningSql(
) const;
/// <summary>
/// GetSQL returns one Hanzo SQL database&#39;s metadata.
/// </summary>
/// <remarks>
/// GetSQL returns one Hanzo SQL database&#39;s metadata. It carries the database&#39;s status, its instance address and the admin user Postgres booted with — never the password, which is returned once at create and otherwise lives only in Hanzo KMS. A still-booting instance reads \&quot;provisioning\&quot;, reconciled from the operator&#39;s live view rather than from the row.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningSqlByName(
utility::string_t name
) const;
/// <summary>
/// Lists the caller org&#39;s vector collections.
/// </summary>
/// <remarks>
/// Lists the caller org&#39;s vector collections. A collection is a logical resource inside an already-live shared backend, so every one of them is reached through the public gateway rather than at an instance of its own.
/// </remarks>
pplx::task<std::vector<std::shared_ptr<ProvisionedSummary>>> getProvisioningVector(
) const;
/// <summary>
/// Returns one vector collection&#39;s metadata.
/// </summary>
/// <remarks>
/// Returns one vector collection&#39;s metadata. It carries the collection&#39;s status and the gateway address it is reached at, and no username: the backend authenticates with a shared, out-of-band key rather than a per-collection credential, so there is no per-resource user to report.
/// </remarks>
/// <param name="name">Name is the resource&#39;s org-unique slug, from the path. Lower-cased and trimmed before lookup, exactly as it was at create.</param>
pplx::task<std::shared_ptr<ProvisionedResource>> getProvisioningVectorByName(
utility::string_t name
) const;
/// <summary>
/// Launches your org&#39;s OWN Hanzo Datastore instance and answers with its &#x60;datastore://&#x60; connection string.
/// </summary>
/// <remarks>
/// Launches your org&#39;s OWN Hanzo Datastore instance and answers with its &#x60;datastore://&#x60; connection string. The instance is yours alone — a deployment in your own tenant namespace, so its admin credential is naturally scoped to you and no other tenant shares the process. Off-cluster this fails closed with 503 rather than handing back a shared one.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningDatastore(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
/// <summary>
/// CreateDocDB launches your org&#39;s OWN document-database instance and answers with its &#x60;mongodb://&#x60; connection string.
/// </summary>
/// <remarks>
/// CreateDocDB launches your org&#39;s OWN document-database instance and answers with its &#x60;mongodb://&#x60; connection string. It speaks the MongoDB wire protocol, so existing MongoDB drivers connect unchanged. The instance is yours alone — a deployment in your own tenant namespace, so its admin credential is naturally scoped to you and no other tenant shares the process. Off-cluster this fails closed with 503 rather than handing back a shared one.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningDocdb(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
/// <summary>
/// CreateKV launches your org&#39;s OWN key-value instance and answers with its &#x60;kv://&#x60; connection string.
/// </summary>
/// <remarks>
/// CreateKV launches your org&#39;s OWN key-value instance and answers with its &#x60;kv://&#x60; connection string. The instance is yours alone — a deployment in your own tenant namespace, so its admin credential is naturally scoped to you and no other tenant shares the process. Off-cluster this fails closed with 503 rather than handing back a shared one.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningKv(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
/// <summary>
/// Creates an S3-compatible bucket inside the already-running shared object store and answers with the endpoint that reaches it.
/// </summary>
/// <remarks>
/// Creates an S3-compatible bucket inside the already-running shared object store and answers with the endpoint that reaches it.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningS3(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
/// <summary>
/// Creates a search index inside the already-running shared search backend and answers with the endpoint that reaches it.
/// </summary>
/// <remarks>
/// Creates a search index inside the already-running shared search backend and answers with the endpoint that reaches it.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningSearch(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
/// <summary>
/// CreateSQL launches your org&#39;s OWN PostgreSQL instance and answers with its &#x60;postgres://&#x60; connection string.
/// </summary>
/// <remarks>
/// CreateSQL launches your org&#39;s OWN PostgreSQL instance and answers with its &#x60;postgres://&#x60; connection string. The instance is yours alone — a deployment in your own tenant namespace, so its admin credential is naturally scoped to you and no other tenant shares the process. Off-cluster, where there is no orchestrator to launch one, this fails closed with 503 rather than handing back a shared one.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningSql(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
/// <summary>
/// Creates a vector collection inside the already-running shared vector backend and answers with the endpoint that reaches it.
/// </summary>
/// <remarks>
/// Creates a vector collection inside the already-running shared vector backend and answers with the endpoint that reaches it.
/// </remarks>
/// <param name="provisionRequest"></param>
pplx::task<std::shared_ptr<ProvisionResult>> postProvisioningVector(
std::shared_ptr<ProvisionRequest> provisionRequest
) const;
protected:
std::shared_ptr<const ApiClient> m_ApiClient;
};
}
}
#endif /* HANZO_API_ProvisioningApi_H_ */