NuonAPI.Api.Components (nuon v0.19.90)
API calls for all endpoints tagged Components
.
Summary
Functions
create a component
create component build
create a docker build component config
create an external image component config
create a helm component config
create a job component config
create a terraform component config
delete a component
get all components for an app
get a component
get a build for a component
get component build logs
get component build plan
get all builds for a component
get all configs for a component
get latest build for a component
get latest config for a component
get all components for an org
Functions
create_component(connection, app_id, service_create_component_request, opts \\ [])
@spec create_component( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateComponentRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppComponent.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create a component
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDservice_create_component_request
(ServiceCreateComponentRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponent.t}
on success{:error, Tesla.Env.t}
on failure
create_component_build(connection, component_id, service_create_component_build_request, opts \\ [])
@spec create_component_build( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateComponentBuildRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppComponentBuild.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create component build
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_create_component_build_request
(ServiceCreateComponentBuildRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponentBuild.t}
on success{:error, Tesla.Env.t}
on failure
create_docker_build_component_config(connection, component_id, service_create_docker_build_component_config_request, opts \\ [])
@spec create_docker_build_component_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateDockerBuildComponentConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppDockerBuildComponentConfig.t()} | {:error, Tesla.Env.t()}
create a docker build component config
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_create_docker_build_component_config_request
(ServiceCreateDockerBuildComponentConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppDockerBuildComponentConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_external_image_component_config(connection, component_id, service_create_external_image_component_config_request, opts \\ [])
@spec create_external_image_component_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateExternalImageComponentConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppExternalImageComponentConfig.t()} | {:error, Tesla.Env.t()}
create an external image component config
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_create_external_image_component_config_request
(ServiceCreateExternalImageComponentConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppExternalImageComponentConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_helm_component_config(connection, component_id, service_create_helm_component_config_request, opts \\ [])
@spec create_helm_component_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateHelmComponentConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppHelmComponentConfig.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create a helm component config
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_create_helm_component_config_request
(ServiceCreateHelmComponentConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppHelmComponentConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_job_component_config(connection, component_id, service_create_job_component_config_request, opts \\ [])
@spec create_job_component_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateJobComponentConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppJobComponentConfig.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create a job component config
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_create_job_component_config_request
(ServiceCreateJobComponentConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppJobComponentConfig.t}
on success{:error, Tesla.Env.t}
on failure
create_terraform_module_component_config(connection, component_id, service_create_terraform_module_component_config_request, opts \\ [])
@spec create_terraform_module_component_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateTerraformModuleComponentConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppTerraformModuleComponentConfig.t()} | {:error, Tesla.Env.t()}
create a terraform component config
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_create_terraform_module_component_config_request
(ServiceCreateTerraformModuleComponentConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppTerraformModuleComponentConfig.t}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
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 serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppComponent{}, ...]}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponent.t}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDbuild_id
(String.t): build IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponentBuild.t}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDbuild_id
(String.t): build IDopts
(keyword): Optional parameters
Returns
{:ok, [%AnyType{}, ...]}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDbuild_id
(String.t): build IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.Planv1Plan.t}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppComponentBuild{}, ...]}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppComponentConfigConnection{}, ...]}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponentBuild.t}
on success{:error, Tesla.Env.t}
on failure
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 servercomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponentConfigConnection.t}
on success{:error, Tesla.Env.t}
on failure
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 serveropts
(keyword): Optional parameters
Returns
{:ok, [%AppComponent{}, ...]}
on success{:error, Tesla.Env.t}
on failure
update_component(connection, component_id, service_update_component_request, opts \\ [])
@spec update_component( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceUpdateComponentRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppComponent.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
update a component
Parameters
connection
(NuonAPI.Connection): Connection to servercomponent_id
(String.t): component IDservice_update_component_request
(ServiceUpdateComponentRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppComponent.t}
on success{:error, Tesla.Env.t}
on failure