Package

com.hashicorp.nomad

scalasdk

Permalink

package scalasdk

An SDK for interacting with Nomad from Scala.

The central class in the SDK is com.hashicorp.nomad.scalasdk.NomadScalaApi.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. scalasdk
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class NomadScalaApi extends AnyRef

    Permalink

    An API for interacting with Nomad in Scala.

    An API for interacting with Nomad in Scala.

    The Scala API is a wrapper for the NomadApiClient from the Nomad Java SDK that provides more Scala friendly types for convenient use from Scala.

  2. class ScalaAgentApi extends AnyRef

    Permalink

    Scala API for Nomad agent and cluster management, exposing the functionality of the /v1/agent/… endpoints of the Nomad HTTP API.

  3. class ScalaAllocationsApi extends AnyRef

    Permalink

    API for querying for information about allocations, exposing the functionality of the /v1/allocations and /v1/allocation endpoints of the Nomad HTTP API.

  4. class ScalaClientApi extends AnyRef

    Permalink

    API for interacting with a particular Nomad client, exposing the functionality of the /v1/client/… endpoints of the Nomad HTTP API.

  5. class ScalaDeploymentsApi extends AnyRef

    Permalink

    API for querying for information about deployments, exposing the deployments functionality of the Nomad HTTP API.

  6. class ScalaEvaluationsApi extends AnyRef

    Permalink

    API for querying for information about evaluations, exposing the functionality of the /v1/evaluations and /v1/evaluation endpoints of the Nomad HTTP API.

  7. class ScalaJobsApi extends AnyRef

    Permalink

    API for managing and querying jobs, exposing the functionality of the /v1/jobs and /v1/job endpoints of the Nomad HTTP API.

    API for managing and querying jobs, exposing the functionality of the /v1/jobs and /v1/job endpoints of the Nomad HTTP API.

    See also

    Job Specification for documentation about the Job structure.

  8. class ScalaNodesApi extends AnyRef

    Permalink

    API for querying for information about client nodes, exposing the functionality of the /v1/nodes and /v1/node endpoints of the Nomad HTTP API.

  9. class ScalaOperatorApi extends AnyRef

    Permalink

    API for operating a Nomad cluster, exposing the operator functionality of the Nomad HTTP API.

  10. case class ScalaQueryOptions[A](region: Option[String] = None, index: Option[BigInteger] = None, waitStrategy: Option[WaitStrategy] = None, allowStale: Boolean = false, repeatedPollPredicate: Option[(ServerQueryResponse[A]) ⇒ Boolean] = None) extends Product with Serializable

    Permalink

    Options for queries to a Nomad server API.

    Options for queries to a Nomad server API.

    A

    the expected response type.

    region

    the region to which the request should be forwarded (when None the API's region setting is used)

    index

    the long-polling query index to use for blocking queries

    waitStrategy

    the wait strategy to use for long-polling blocking queries

    allowStale

    whether to allow stale responses (see Consistency Modes)

    repeatedPollPredicate

    when specified, the server is repeatedly polled until the response satisfied the predicate or the waitStrategy throws a TimeoutException.

    See also

    Blocking Queries

  11. class ScalaRegionsApi extends AnyRef

    Permalink

    API for querying for information about regions, exposing the functionality of the /v1/regions endpoint of the Nomad HTTP API.

  12. class ScalaSearchApi extends AnyRef

    Permalink

    API for performing searches in the Nomad cluster, exposing the search functionality of the Nomad HTTP API.

  13. class ScalaStatusApi extends AnyRef

    Permalink

    API for querying for information about the status of the cluster, exposing the functionality of the /v1/status/… endpoints of the Nomad HTTP API.

    API for querying for information about the status of the cluster, exposing the functionality of the /v1/status/… endpoints of the Nomad HTTP API.

    See also

    /v1/status documentation

  14. class ScalaSystemApi extends AnyRef

    Permalink

    API for performing system maintenance that shouldn't be necessary for most users, exposing the functionality of the /v1/system/… endpoints of the Nomad HTTP API.

Value Members

  1. object NomadScalaApi

    Permalink

    Companion object for NomadScalaApi with helpful apply methods.

Inherited from AnyRef

Inherited from Any

Ungrouped