nomad_client v0.13.0

NomadClient.Api.Deployments (nomad_client v0.13.0)

API calls for all endpoints tagged Deployments.

Link to this section Summary

Functions

get_deployment(connection, deployment_id, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment 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.Deployment.t} on success
  • {:error, Tesla.Env.t} on failure
get_deployment_allocations(connection, deployment_id, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment 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, [%AllocationListStub{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
get_deployments(connection, opts \\ [])

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, [%Deployment{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
post_deployment_allocation_health(connection, deployment_id, deployment_alloc_health_request, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_alloc_health_request (DeploymentAllocHealthRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
post_deployment_fail(connection, deployment_id, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment 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, NomadClient.Model.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
post_deployment_pause(connection, deployment_id, deployment_pause_request, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_pause_request (DeploymentPauseRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
post_deployment_promote(connection, deployment_id, deployment_promote_request, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_promote_request (DeploymentPromoteRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
post_deployment_unblock(connection, deployment_id, deployment_unblock_request, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_unblock_request (DeploymentUnblockRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure

Link to this section Functions

Link to this function

get_deployment(connection, deployment_id, opts \\ [])

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

parameters

 Parameters

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

get_deployment_allocations(connection, deployment_id, opts \\ [])

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

parameters

 Parameters

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

get_deployments(connection, opts \\ [])

@spec get_deployments(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, [NomadClient.Model.Deployment.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, [%Deployment{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_deployment_allocation_health(connection, deployment_id, deployment_alloc_health_request, opts \\ [])

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

parameters

 Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_alloc_health_request (DeploymentAllocHealthRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_deployment_fail(connection, deployment_id, opts \\ [])

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

parameters

 Parameters

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

post_deployment_pause(connection, deployment_id, deployment_pause_request, opts \\ [])

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

parameters

 Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_pause_request (DeploymentPauseRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_deployment_promote(connection, deployment_id, deployment_promote_request, opts \\ [])

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

parameters

 Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_promote_request (DeploymentPromoteRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

post_deployment_unblock(connection, deployment_id, deployment_unblock_request, opts \\ [])

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

parameters

 Parameters

  • connection (NomadClient.Connection): Connection to server
  • deployment_id (String.t): Deployment ID.
  • deployment_unblock_request (DeploymentUnblockRequest):
  • 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.DeploymentUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure