Class

com.hashicorp.nomad.scalasdk

ScalaNodesApi

Related Doc: package scalasdk

Permalink

class ScalaNodesApi extends AnyRef

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

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

Instance Constructors

  1. new ScalaNodesApi(nodesApi: NodesApi)

    Permalink

    nodesApi

    the underlying API from the Java SDK

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def allocations(nodeId: String, options: Option[ScalaQueryOptions[Seq[AllocationListStub]]] = None): ServerQueryResponse[Seq[AllocationListStub]]

    Permalink

    List the allocations belonging to a nodes in the active region.

    List the allocations belonging to a nodes in the active region.

    nodeId

    ID of the node to list allocations for

    options

    options controlling how the request is performed

    See also

    GET /v1/node/{ID}/allocations

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def forceEvaluate(nodeId: String, options: Option[WriteOptions] = None): ServerResponse[Unit]

    Permalink

    Creates a new evaluation for a node.

    Creates a new evaluation for a node.

    nodeId

    ID of the node to evaluate

    options

    options controlling how the request is performed

    See also

    PUT /v1/node/<ID>/evaluate

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def info(nodeId: String, options: Option[ScalaQueryOptions[Node]] = None): ServerQueryResponse[Node]

    Permalink

    Queries a node in the active region.

    Queries a node in the active region.

    nodeId

    ID of the node to query

    options

    options controlling how the request is performed

    See also

    GET /v1/node/{ID}

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def list(nodeIdPrefix: Option[String] = None, options: Option[ScalaQueryOptions[Seq[NodeListStub]]] = None): ServerQueryResponse[Seq[NodeListStub]]

    Permalink

    Lists client nodes in the active region.

    Lists client nodes in the active region.

    nodeIdPrefix

    an even-length prefix that, if given, restricts the results to only nodes having an ID with this prefix

    options

    options controlling how the request is performed

    See also

    GET /v1/nodes

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. def toggleDrain(nodeId: String, enabled: Boolean, options: Option[WriteOptions] = None): ServerResponse[Unit]

    Permalink

    Toggles drain mode on or off on a node in the active region.

    Toggles drain mode on or off on a node in the active region.

    When drain mode is enabled, no further allocations will be assigned and existing allocations will be migrated.

    nodeId

    ID of the node to control

    enabled

    drain mode is turned on when this is true, and off when false.

    options

    options controlling how the request is performed

    See also

    PUT /v1/node/{ID}/drain

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped