NuonAPI.Api.Components (nuon v0.19.90)

API calls for all endpoints tagged Components.

Summary

Functions

get all components for an org

Functions

Link to this function

create_component(connection, app_id, service_create_component_request, opts \\ [])

create a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • app_id (String.t): app ID
  • service_create_component_request (ServiceCreateComponentRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_component_build(connection, component_id, service_create_component_build_request, opts \\ [])

create component build

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_create_component_build_request (ServiceCreateComponentBuildRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_docker_build_component_config(connection, component_id, service_create_docker_build_component_config_request, opts \\ [])

create a docker build component config

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_create_docker_build_component_config_request (ServiceCreateDockerBuildComponentConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_external_image_component_config(connection, component_id, service_create_external_image_component_config_request, opts \\ [])

create an external image component config

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_create_external_image_component_config_request (ServiceCreateExternalImageComponentConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_helm_component_config(connection, component_id, service_create_helm_component_config_request, opts \\ [])

create a helm component config

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_create_helm_component_config_request (ServiceCreateHelmComponentConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_job_component_config(connection, component_id, service_create_job_component_config_request, opts \\ [])

create a job component config

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_create_job_component_config_request (ServiceCreateJobComponentConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_terraform_module_component_config(connection, component_id, service_create_terraform_module_component_config_request, opts \\ [])

create a terraform component config

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_create_terraform_module_component_config_request (ServiceCreateTerraformModuleComponentConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

delete_component(connection, component_id, opts \\ [])

@spec delete_component(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, boolean()}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

delete a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • opts (keyword): Optional parameters

Returns

  • {:ok, boolean()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_app_components(connection, app_id, opts \\ [])

@spec get_app_components(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [NuonAPI.Model.AppComponent.t()]}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get all components for an app

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • app_id (String.t): app ID
  • opts (keyword): Optional parameters

Returns

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

get_component(connection, component_id, opts \\ [])

@spec get_component(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, NuonAPI.Model.AppComponent.t()}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • opts (keyword): Optional parameters

Returns

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

get_component_build(connection, component_id, build_id, opts \\ [])

@spec get_component_build(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, NuonAPI.Model.AppComponentBuild.t()}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get a build for a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • build_id (String.t): build ID
  • opts (keyword): Optional parameters

Returns

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

get_component_build_logs(connection, component_id, build_id, opts \\ [])

@spec get_component_build_logs(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, [any()]}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get component build logs

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • build_id (String.t): build ID
  • opts (keyword): Optional parameters

Returns

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

get_component_build_plan(connection, component_id, build_id, opts \\ [])

@spec get_component_build_plan(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, NuonAPI.Model.Planv1Plan.t()}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get component build plan

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • build_id (String.t): build ID
  • opts (keyword): Optional parameters

Returns

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

get_component_builds(connection, component_id, opts \\ [])

@spec get_component_builds(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [NuonAPI.Model.AppComponentBuild.t()]}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get all builds for a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • opts (keyword): Optional parameters

Returns

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

get_component_configs(connection, component_id, opts \\ [])

@spec get_component_configs(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:ok, [NuonAPI.Model.AppComponentConfigConnection.t()]}
  | {:error, Tesla.Env.t()}

get all configs for a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • opts (keyword): Optional parameters

Returns

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

get_component_latest_build(connection, component_id, opts \\ [])

@spec get_component_latest_build(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, NuonAPI.Model.AppComponentBuild.t()}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get latest build for a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • opts (keyword): Optional parameters

Returns

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

get_component_latest_config(connection, component_id, opts \\ [])

@spec get_component_latest_config(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:ok, NuonAPI.Model.AppComponentConfigConnection.t()}
  | {:error, Tesla.Env.t()}

get latest config for a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • opts (keyword): Optional parameters

Returns

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

get_org_components(connection, opts \\ [])

@spec get_org_components(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [NuonAPI.Model.AppComponent.t()]}
  | {:ok, NuonAPI.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get all components for an org

Parameters

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

Returns

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

update_component(connection, component_id, service_update_component_request, opts \\ [])

update a component

Parameters

  • connection (NuonAPI.Connection): Connection to server
  • component_id (String.t): component ID
  • service_update_component_request (ServiceUpdateComponentRequest): Input
  • opts (keyword): Optional parameters

Returns

  • {:ok, NuonAPI.Model.AppComponent.t} on success
  • {:error, Tesla.Env.t} on failure