Nuon.Api.Installs (nuon v0.19.90)
API calls for all endpoints tagged Installs
.
Summary
Functions
create an app install
deploy a build to an install
create install inputs
delete an install
get all installs for an app
get an installs current inputs
get an install
get an install component
get an install components deploys
get the latest deploy for an install component
get an installs components
get an install deploy
get install deploy logs
get install deploy plan
get all deploys to an install
get an install event Get a single install event.
get events for an install
get an installs inputs
get an install deploy
get install sandbox run logs
get an installs sandbox runs
get all installs for an org
teardown an install component
Functions
create_install(connection, app_id, service_create_install_request, opts \\ [])
@spec create_install( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateInstallRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppInstall.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create an app install
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDservice_create_install_request
(ServiceCreateInstallRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstall.t}
on success{:error, Tesla.Env.t}
on failure
create_install_deploy(connection, install_id, service_create_install_deploy_request, opts \\ [])
@spec create_install_deploy( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateInstallDeployRequest.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallDeploy.t()} | {:error, Tesla.Env.t()}
deploy a build to an install
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDservice_create_install_deploy_request
(ServiceCreateInstallDeployRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallDeploy.t}
on success{:error, Tesla.Env.t}
on failure
create_install_inputs(connection, install_id, service_create_install_inputs_request, opts \\ [])
@spec create_install_inputs( Tesla.Env.client(), String.t(), Nuon.Model.ServiceCreateInstallInputsRequest.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallInputs.t()} | {:error, Tesla.Env.t()}
create install inputs
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDservice_create_install_inputs_request
(ServiceCreateInstallInputsRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallInputs.t}
on success{:error, Tesla.Env.t}
on failure
delete_install(connection, install_id, opts \\ [])
@spec delete_install(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, boolean()} | {:error, Tesla.Env.t()}
delete an install
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
get_app_installs(connection, app_id, opts \\ [])
@spec get_app_installs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppInstall.t()]} | {:error, Tesla.Env.t()}
get all installs for an app
Parameters
connection
(Nuon.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstall{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_current_install_inputs(connection, install_id, opts \\ [])
@spec get_current_install_inputs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallInputs.t()} | {:error, Tesla.Env.t()}
get an installs current inputs
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallInputs.t}
on success{:error, Tesla.Env.t}
on failure
get_install(connection, install_id, opts \\ [])
@spec get_install(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.AppInstall.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get an install
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstall.t}
on success{:error, Tesla.Env.t}
on failure
get_install_component(connection, install_id, component_id, opts \\ [])
@spec get_install_component(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallComponent.t()} | {:error, Tesla.Env.t()}
get an install component
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDcomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallComponent.t}
on success{:error, Tesla.Env.t}
on failure
get_install_component_deploys(connection, install_id, component_id, opts \\ [])
@spec get_install_component_deploys( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppInstallDeploy.t()]} | {:error, Tesla.Env.t()}
get an install components deploys
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDcomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstallDeploy{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_component_latest_deploy(connection, install_id, component_id, opts \\ [])
@spec get_install_component_latest_deploy( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallDeploy.t()} | {:error, Tesla.Env.t()}
get the latest deploy for an install component
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDcomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallDeploy.t}
on success{:error, Tesla.Env.t}
on failure
get_install_components(connection, install_id, opts \\ [])
@spec get_install_components(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [Nuon.Model.AppInstallComponent.t()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get an installs components
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstallComponent{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_deploy(connection, install_id, deploy_id, opts \\ [])
@spec get_install_deploy(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallDeploy.t()} | {:error, Tesla.Env.t()}
get an install deploy
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDdeploy_id
(String.t): deploy IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallDeploy.t}
on success{:error, Tesla.Env.t}
on failure
get_install_deploy_logs(connection, install_id, deploy_id, opts \\ [])
@spec get_install_deploy_logs(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, [any()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get install deploy logs
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDdeploy_id
(String.t): deploy IDopts
(keyword): Optional parameters
Returns
{:ok, [%AnyType{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_deploy_plan(connection, install_id, deploy_id, opts \\ [])
@spec get_install_deploy_plan(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.Planv1Plan.t()} | {:error, Tesla.Env.t()}
get install deploy plan
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDdeploy_id
(String.t): deploy IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.Planv1Plan.t}
on success{:error, Tesla.Env.t}
on failure
get_install_deploys(connection, install_id, opts \\ [])
@spec get_install_deploys(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppInstallDeploy.t()]} | {:error, Tesla.Env.t()}
get all deploys to an install
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstallDeploy{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_event(connection, install_id, event_id, opts \\ [])
@spec get_install_event(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallEvent.t()} | {:error, Tesla.Env.t()}
get an install event Get a single install event.
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDevent_id
(String.t): event IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallEvent.t}
on success{:error, Tesla.Env.t}
on failure
get_install_events(connection, install_id, opts \\ [])
@spec get_install_events(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [Nuon.Model.AppInstallEvent.t()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get events for an install
Get Install Events Return an event stream for an install.
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstallEvent{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_inputs(connection, install_id, opts \\ [])
@spec get_install_inputs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppInstallInputs.t()]} | {:error, Tesla.Env.t()}
get an installs inputs
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstallInputs{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_latest_deploy(connection, install_id, opts \\ [])
@spec get_install_latest_deploy(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallDeploy.t()} | {:error, Tesla.Env.t()}
get an install deploy
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallDeploy.t}
on success{:error, Tesla.Env.t}
on failure
get_install_sandbox_run_logs(connection, install_id, run_id, opts \\ [])
@spec get_install_sandbox_run_logs( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, [any()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get install sandbox run logs
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDrun_id
(String.t): run IDopts
(keyword): Optional parameters
Returns
{:ok, [%AnyType{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_install_sandbox_runs(connection, install_id, opts \\ [])
@spec get_install_sandbox_runs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [Nuon.Model.AppInstallSandboxRun.t()]} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get an installs sandbox runs
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDopts
(keyword): Optional parameters
Returns
{:ok, [%AppInstallSandboxRun{}, ...]}
on success{:error, Tesla.Env.t}
on failure
get_org_installs(connection, opts \\ [])
@spec get_org_installs( Tesla.Env.client(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, [Nuon.Model.AppInstall.t()]} | {:error, Tesla.Env.t()}
get all installs for an org
Parameters
connection
(Nuon.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, [%AppInstall{}, ...]}
on success{:error, Tesla.Env.t}
on failure
teardown_install_component(connection, install_id, component_id, opts \\ [])
@spec teardown_install_component( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, Nuon.Model.StderrErrResponse.t()} | {:ok, Nuon.Model.AppInstallDeploy.t()} | {:error, Tesla.Env.t()}
teardown an install component
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): install IDcomponent_id
(String.t): component IDopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstallDeploy.t}
on success{:error, Tesla.Env.t}
on failure
update_install(connection, install_id, service_update_install_request, opts \\ [])
@spec update_install( Tesla.Env.client(), String.t(), Nuon.Model.ServiceUpdateInstallRequest.t(), keyword() ) :: {:ok, Nuon.Model.AppInstall.t()} | {:ok, Nuon.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
update an install
Parameters
connection
(Nuon.Connection): Connection to serverinstall_id
(String.t): app IDservice_update_install_request
(ServiceUpdateInstallRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, Nuon.Model.AppInstall.t}
on success{:error, Tesla.Env.t}
on failure