NomadClient.Api.ACL (nomad_client v0.13.1)

API calls for all endpoints tagged ACL.

Link to this section Summary

Functions

Parameters

  • connection (NomadClient.Connection): Connection to server
  • policy_name (String.t): The ACL policy name.
  • 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 server
  • token_accessor (String.t): The token accessor ID.
  • 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 server
  • 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, [%AclPolicyListStub{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • policy_name (String.t): The ACL policy name.
  • 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.AclPolicy.t} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • token_accessor (String.t): The token accessor ID.
  • 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.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, [%AclTokenListStub{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, NomadClient.Model.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • policy_name (String.t): The ACL policy name.
  • acl_policy (AclPolicy):
  • 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 server
  • token_accessor (String.t): The token accessor ID.
  • acl_token (AclToken):
  • 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, NomadClient.Model.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, NomadClient.Model.OneTimeToken.t} on success
  • {:error, Tesla.Env.t} on failure

Parameters

  • connection (NomadClient.Connection): Connection to server
  • one_time_token_exchange_request (OneTimeTokenExchangeRequest):
  • 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, NomadClient.Model.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure

Link to this section Functions

Link to this function

delete_acl_policy(connection, policy_name, opts \\ [])

@spec delete_acl_policy(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • policy_name (String.t): The ACL policy name.
  • 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_acl_token(connection, token_accessor, opts \\ [])

@spec delete_acl_token(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • token_accessor (String.t): The token accessor ID.
  • 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_acl_policies(connection, opts \\ [])

@spec get_acl_policies(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [NomadClient.Model.AclPolicyListStub.t()]}
  | {:ok, nil}
  | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, [%AclPolicyListStub{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_acl_policy(connection, policy_name, opts \\ [])

@spec get_acl_policy(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, NomadClient.Model.AclPolicy.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • policy_name (String.t): The ACL policy name.
  • 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.AclPolicy.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_acl_token(connection, token_accessor, opts \\ [])

@spec get_acl_token(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, NomadClient.Model.AclToken.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • token_accessor (String.t): The token accessor ID.
  • 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.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_acl_token_self(connection, opts \\ [])

@spec get_acl_token_self(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil} | {:ok, NomadClient.Model.AclToken.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_acl_tokens(connection, opts \\ [])

@spec get_acl_tokens(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, [NomadClient.Model.AclTokenListStub.t()]}
  | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, [%AclTokenListStub{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_acl_bootstrap(connection, opts \\ [])

@spec post_acl_bootstrap(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil} | {:ok, NomadClient.Model.AclToken.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, NomadClient.Model.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_acl_policy(connection, policy_name, acl_policy, opts \\ [])

@spec post_acl_policy(
  Tesla.Env.client(),
  String.t(),
  NomadClient.Model.AclPolicy.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • policy_name (String.t): The ACL policy name.
  • acl_policy (AclPolicy):
  • 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

post_acl_token(connection, token_accessor, acl_token, opts \\ [])

@spec post_acl_token(
  Tesla.Env.client(),
  String.t(),
  NomadClient.Model.AclToken.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, NomadClient.Model.AclToken.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • token_accessor (String.t): The token accessor ID.
  • acl_token (AclToken):
  • 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, NomadClient.Model.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_acl_token_onetime(connection, opts \\ [])

@spec post_acl_token_onetime(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, NomadClient.Model.OneTimeToken.t()}
  | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • 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, NomadClient.Model.OneTimeToken.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_acl_token_onetime_exchange(connection, one_time_token_exchange_request, opts \\ [])

@spec post_acl_token_onetime_exchange(
  Tesla.Env.client(),
  NomadClient.Model.OneTimeTokenExchangeRequest.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, NomadClient.Model.AclToken.t()} | {:error, Tesla.Env.t()}

parameters

Parameters

  • connection (NomadClient.Connection): Connection to server
  • one_time_token_exchange_request (OneTimeTokenExchangeRequest):
  • 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, NomadClient.Model.AclToken.t} on success
  • {:error, Tesla.Env.t} on failure