Nuon.Api.General (nuon v0.19.136)

API calls for all endpoints tagged General.

Summary

Functions

Get regions for a cloud platform Return region metadata for the Nuon supported cloud platforms.

Publish a metric from different Nuon clients for telemetry purposes.

Functions

Link to this function

get_cli_config(connection, opts \\ [])

@spec get_cli_config(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Nuon.Model.StderrErrResponse.t()}
  | {:ok, Nuon.Model.ServiceCliConfig.t()}
  | {:error, Tesla.Env.t()}

Get config for cli

Parameters

  • connection (Nuon.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, Nuon.Model.ServiceCliConfig.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_cloud_platform_regions(connection, cloud_platform, opts \\ [])

@spec get_cloud_platform_regions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [Nuon.Model.AppCloudPlatformRegion.t()]}
  | {:ok, Nuon.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

Get regions for a cloud platform Return region metadata for the Nuon supported cloud platforms.

Parameters

  • connection (Nuon.Connection): Connection to server
  • cloud_platform (String.t): cloud platform
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%AppCloudPlatformRegion{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_current_user(connection, opts \\ [])

@spec get_current_user(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Nuon.Model.StderrErrResponse.t()}
  | {:ok, Nuon.Model.AppUserToken.t()}
  | {:error, Tesla.Env.t()}

Get current user

Parameters

  • connection (Nuon.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, Nuon.Model.AppUserToken.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

publish_metrics(connection, service_publish_metric_input, opts \\ [])

@spec publish_metrics(
  Tesla.Env.client(),
  [Nuon.Model.ServicePublishMetricInput.t()],
  keyword()
) ::
  {:ok, Nuon.Model.StderrErrResponse.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Publish a metric from different Nuon clients for telemetry purposes.

Parameters

  • connection (Nuon.Connection): Connection to server
  • service_publish_metric_input ([Nuon.Model.ServicePublishMetricInput.t]): Input
  • opts (keyword): Optional parameters

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure