NomadClient.Api.Enterprise (nomad_client v0.13.0)
API calls for all endpoints tagged Enterprise.
Link to this section Summary
Functions
Parameters
connection(NomadClient.Connection): Connection to serverquota_spec(QuotaSpec):opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:x_nomad_token(String.t): A Nomad ACL token.:idempotency_token(String.t): Can be used to ensure operations are only run once.
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
Parameters
connection(NomadClient.Connection): Connection to serverspec_name(String.t): The quota spec identifier.opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:x_nomad_token(String.t): A Nomad ACL token.:idempotency_token(String.t): Can be used to ensure operations are only run once.
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
Parameters
connection(NomadClient.Connection): Connection to serverspec_name(String.t): The quota spec identifier.opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:index(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait(String.t): Provided with IndexParam to wait for change.:stale(String.t): If present, results will include stale reads.:prefix(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token(String.t): A Nomad ACL token.:per_page(integer()): Maximum number of results to return.:next_token(String.t): Indicates where to start paging for queries that support pagination.
Returns
{:ok, NomadClient.Model.QuotaSpec.t}on success{:error, Tesla.Env.t}on failure
Parameters
connection(NomadClient.Connection): Connection to serveropts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:index(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait(String.t): Provided with IndexParam to wait for change.:stale(String.t): If present, results will include stale reads.:prefix(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token(String.t): A Nomad ACL token.:per_page(integer()): Maximum number of results to return.:next_token(String.t): Indicates where to start paging for queries that support pagination.
Returns
{:ok, [any(), ...]}on success{:error, Tesla.Env.t}on failure
Parameters
connection(NomadClient.Connection): Connection to serverspec_name(String.t): The quota spec identifier.quota_spec(QuotaSpec):opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:x_nomad_token(String.t): A Nomad ACL token.:idempotency_token(String.t): Can be used to ensure operations are only run once.
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
Link to this section Functions
Link to this function
create_quota_spec(connection, quota_spec, opts \\ [])
@spec create_quota_spec( Tesla.Env.client(), NomadClient.Model.QuotaSpec.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
connection(NomadClient.Connection): Connection to serverquota_spec(QuotaSpec):opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:x_nomad_token(String.t): A Nomad ACL token.:idempotency_token(String.t): Can be used to ensure operations are only run once.
returns
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
Link to this function
delete_quota_spec(connection, spec_name, opts \\ [])
@spec delete_quota_spec(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
connection(NomadClient.Connection): Connection to serverspec_name(String.t): The quota spec identifier.opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:x_nomad_token(String.t): A Nomad ACL token.:idempotency_token(String.t): Can be used to ensure operations are only run once.
returns
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
Link to this function
get_quota_spec(connection, spec_name, opts \\ [])
@spec get_quota_spec(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, NomadClient.Model.QuotaSpec.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
connection(NomadClient.Connection): Connection to serverspec_name(String.t): The quota spec identifier.opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:index(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait(String.t): Provided with IndexParam to wait for change.:stale(String.t): If present, results will include stale reads.:prefix(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token(String.t): A Nomad ACL token.:per_page(integer()): Maximum number of results to return.:next_token(String.t): Indicates where to start paging for queries that support pagination.
returns
Returns
{:ok, NomadClient.Model.QuotaSpec.t}on success{:error, Tesla.Env.t}on failure
Link to this function
get_quotas(connection, opts \\ [])
@spec get_quotas( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, [any()]} | {:error, Tesla.Env.t()}
parameters
Parameters
connection(NomadClient.Connection): Connection to serveropts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:index(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait(String.t): Provided with IndexParam to wait for change.:stale(String.t): If present, results will include stale reads.:prefix(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token(String.t): A Nomad ACL token.:per_page(integer()): Maximum number of results to return.:next_token(String.t): Indicates where to start paging for queries that support pagination.
returns
Returns
{:ok, [any(), ...]}on success{:error, Tesla.Env.t}on failure
Link to this function
post_quota_spec(connection, spec_name, quota_spec, opts \\ [])
@spec post_quota_spec( Tesla.Env.client(), String.t(), NomadClient.Model.QuotaSpec.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
connection(NomadClient.Connection): Connection to serverspec_name(String.t): The quota spec identifier.quota_spec(QuotaSpec):opts(keyword): Optional parameters:region(String.t): Filters results based on the specified region.:namespace(String.t): Filters results based on the specified namespace.:x_nomad_token(String.t): A Nomad ACL token.:idempotency_token(String.t): Can be used to ensure operations are only run once.
returns
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure