PlatformApi class

Constructors

PlatformApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deletePlatformProjectsByProjectAppsByApp(String project, String app) → Future<void>
Deletes an application and tears down what it runs.
deletePlatformProjectsByProjectAppsByAppDomainsByHost(String project, String app, String host) → Future<void>
Detaches a hostname and releases the claim.
deletePlatformProjectsByProjectAppsByAppDomainsByHostWithHttpInfo(String project, String app, String host) → Future<Response>
Detaches a hostname and releases the claim.
deletePlatformProjectsByProjectAppsByAppWithHttpInfo(String project, String app) → Future<Response>
Deletes an application and tears down what it runs.
getPlatformApps({String? org}) → Future<DeclaredResp?>
Answers what this organisation has declared, joined with what the delivery plane has done about it.
getPlatformAppsByApp(String app, {String? org}) → Future<Declaration?>
Answers ONE declaration — what git says this app is, before the delivery plane has had any say in it.
getPlatformAppsByAppCd(String app, {String? org}) → Future<CDApp?>
Answers ONE app's reconciliation alone — the poll a deploy console makes while it waits, without re-reading the whole inventory each time.
getPlatformAppsByAppCdWithHttpInfo(String app, {String? org}) → Future<Response>
Answers ONE app's reconciliation alone — the poll a deploy console makes while it waits, without re-reading the whole inventory each time.
getPlatformAppsByAppWithHttpInfo(String app, {String? org}) → Future<Response>
Answers ONE declaration — what git says this app is, before the delivery plane has had any say in it.
getPlatformAppsWithHttpInfo({String? org}) → Future<Response>
Answers what this organisation has declared, joined with what the delivery plane has done about it.
getPlatformBuilds() → Future<BuildBoard?>
Returns real build records for your org.
getPlatformBuildsWithHttpInfo() → Future<Response>
Returns real build records for your org.
getPlatformCd() → Future<CdResp?>
Answers every Application the delivery plane holds.
getPlatformCdWithHttpInfo() → Future<Response>
Answers every Application the delivery plane holds.
getPlatformCi() → Future<void>
Continuous integration (not wired)
getPlatformCiWithHttpInfo() → Future<Response>
Continuous integration (not wired)
getPlatformEnvironments() → Future<EnvironmentBoard?>
Returns your deploy targets, and what is running on each.
getPlatformEnvironmentsWithHttpInfo() → Future<Response>
Returns your deploy targets, and what is running on each.
getPlatformFleet({String? env, String? health, String? org, String? drift}) → Future<DriftBoard?>
Returns the platform's own service tier, and where it has drifted.
getPlatformFleetByApp(String app, {String? env}) → Future<AppView?>
Returns one platform service, resolved to production by default.
getPlatformFleetByAppWithHttpInfo(String app, {String? env}) → Future<Response>
Returns one platform service, resolved to production by default.
getPlatformFleetWithHttpInfo({String? env, String? health, String? org, String? drift}) → Future<Response>
Returns the platform's own service tier, and where it has drifted.
getPlatformHealth() → Future<Readiness?>
Reports whether this control plane can actually deploy anything.
getPlatformHealthWithHttpInfo() → Future<Response>
Reports whether this control plane can actually deploy anything.
getPlatformPipelines() → Future<PipelineBoard?>
Returns one build-and-deploy pipeline per app, with its latest run.
getPlatformPipelinesWithHttpInfo() → Future<Response>
Returns one build-and-deploy pipeline per app, with its latest run.
getPlatformProjects() → Future<List<ProjectView>?>
Returns your org's projects, each with how many apps live under it.
getPlatformProjectsByProject(String project) → Future<ProjectView?>
Returns one project and its app count.
getPlatformProjectsByProjectApps(String project) → Future<List<AppView>?>
Returns the applications in one project, with what the cluster says about them.
getPlatformProjectsByProjectAppsByApp(String project, String app) → Future<AppView?>
Returns one application, with its live phase, health and secret sync.
getPlatformProjectsByProjectAppsByAppDeployments(String project, String app) → Future<List<DeploymentView>?>
Returns an app's deployment history.
getPlatformProjectsByProjectAppsByAppDeploymentsById(String project, String app, String id) → Future<DeploymentView?>
Returns one deployment of one app.
getPlatformProjectsByProjectAppsByAppDeploymentsByIdLogs(String project, String app, String id) → Future<DeployLogs?>
Returns real logs for a deployment — the build's, then the app's.
getPlatformProjectsByProjectAppsByAppDeploymentsByIdLogsWithHttpInfo(String project, String app, String id) → Future<Response>
Returns real logs for a deployment — the build's, then the app's.
getPlatformProjectsByProjectAppsByAppDeploymentsByIdWithHttpInfo(String project, String app, String id) → Future<Response>
Returns one deployment of one app.
getPlatformProjectsByProjectAppsByAppDeploymentsWithHttpInfo(String project, String app) → Future<Response>
Returns an app's deployment history.
getPlatformProjectsByProjectAppsByAppDomains(String project, String app) → Future<List<DomainView>?>
Returns every hostname this app answers on.
getPlatformProjectsByProjectAppsByAppDomainsWithHttpInfo(String project, String app) → Future<Response>
Returns every hostname this app answers on.
getPlatformProjectsByProjectAppsByAppWithHttpInfo(String project, String app) → Future<Response>
Returns one application, with its live phase, health and secret sync.
getPlatformProjectsByProjectAppsWithHttpInfo(String project) → Future<Response>
Returns the applications in one project, with what the cluster says about them.
getPlatformProjectsByProjectWithHttpInfo(String project) → Future<Response>
Returns one project and its app count.
getPlatformProjectsWithHttpInfo() → Future<Response>
Returns your org's projects, each with how many apps live under it.
getPlatformReleases() → Future<ReleaseBoard?>
Returns the versions that actually reached the cluster.
getPlatformReleasesWithHttpInfo() → Future<Response>
Returns the versions that actually reached the cluster.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postPlatformApps() → Future<void>
Deploy an app through cd.hanzo.ai
postPlatformAppsWithHttpInfo() → Future<Response>
Deploy an app through cd.hanzo.ai
postPlatformFleetByAppDeploy(String app, RestartRef restartRef) → Future<Restarted?>
Rolls a platform service's pods, in a named environment.
postPlatformFleetByAppDeployWithHttpInfo(String app, RestartRef restartRef) → Future<Response>
Rolls a platform service's pods, in a named environment.
postPlatformHook({Push? push}) → Future<Verdict?>
Receive a push from the forge and trigger its build
postPlatformHookWithHttpInfo({Push? push}) → Future<Response>
Receive a push from the forge and trigger its build
postPlatformProjectsByProjectApps(String project, CreateAppReq createAppReq) → Future<AppView?>
Creates an application from a git repo or a container image.
postPlatformProjectsByProjectAppsByAppDeploy(String project, String app, DeployReq deployReq) → Future<DeploymentView?>
Deploys the app — building it first if it comes from git.
postPlatformProjectsByProjectAppsByAppDeployWithHttpInfo(String project, String app, DeployReq deployReq) → Future<Response>
Deploys the app — building it first if it comes from git.
postPlatformProjectsByProjectAppsByAppDomains(String project, String app, AddDomainReq addDomainReq) → Future<DomainView?>
Attaches a hostname — instantly if you already own it, otherwise with a DNS challenge.
postPlatformProjectsByProjectAppsByAppDomainsByHostVerify(String project, String app, String host) → Future<DomainView?>
Checks a custom domain's DNS and turns it on if it passes.
postPlatformProjectsByProjectAppsByAppDomainsByHostVerifyWithHttpInfo(String project, String app, String host) → Future<Response>
Checks a custom domain's DNS and turns it on if it passes.
postPlatformProjectsByProjectAppsByAppDomainsWithHttpInfo(String project, String app, AddDomainReq addDomainReq) → Future<Response>
Attaches a hostname — instantly if you already own it, otherwise with a DNS challenge.
postPlatformProjectsByProjectAppsByAppPreview(String project, String app, PreviewReq previewReq) → Future<PreviewView?>
Puts a branch on its own URL.
postPlatformProjectsByProjectAppsByAppPreviewWithHttpInfo(String project, String app, PreviewReq previewReq) → Future<Response>
Puts a branch on its own URL.
postPlatformProjectsByProjectAppsByAppPromote(String project, String app, PromoteReq promoteReq) → Future<DeploymentView?>
Promotes an already-built release to the app.
postPlatformProjectsByProjectAppsByAppPromoteWithHttpInfo(String project, String app, PromoteReq promoteReq) → Future<Response>
Promotes an already-built release to the app.
postPlatformProjectsByProjectAppsByAppRollback(String project, String app, RollbackReq rollbackReq) → Future<DeploymentView?>
Goes back to the previous release.
postPlatformProjectsByProjectAppsByAppRollbackWithHttpInfo(String project, String app, RollbackReq rollbackReq) → Future<Response>
Goes back to the previous release.
postPlatformProjectsByProjectAppsByAppStart(String project, String app) → Future<AppView?>
Starts a stopped app back up.
postPlatformProjectsByProjectAppsByAppStartWithHttpInfo(String project, String app) → Future<Response>
Starts a stopped app back up.
postPlatformProjectsByProjectAppsByAppStop(String project, String app) → Future<AppView?>
Stops an app without deleting it.
postPlatformProjectsByProjectAppsByAppStopWithHttpInfo(String project, String app) → Future<Response>
Stops an app without deleting it.
postPlatformProjectsByProjectAppsWithHttpInfo(String project, CreateAppReq createAppReq) → Future<Response>
Creates an application from a git repo or a container image.
postPlatformRun(RunReq runReq) → Future<RunView?>
Runs a container image and gives back a URL.
postPlatformRunner(RunnerBuildReq runnerBuildReq) → Future<RunnerBuildResp?>
Triggers a native build — an image, or the binaries a repo declares.
postPlatformRunnerWithHttpInfo(RunnerBuildReq runnerBuildReq) → Future<Response>
Triggers a native build — an image, or the binaries a repo declares.
postPlatformRunWithHttpInfo(RunReq runReq) → Future<Response>
Runs a container image and gives back a URL.
putPlatformProjectsByProjectAppsByAppEnv(String project, String app, SetEnvReq setEnvReq) → Future<AppView?>
Replaces an app's environment variables.
putPlatformProjectsByProjectAppsByAppEnvWithHttpInfo(String project, String app, SetEnvReq setEnvReq) → Future<Response>
Replaces an app's environment variables.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited