Class

com.hashicorp.nomad.scalasdk

ScalaDeploymentsApi

Related Doc: package scalasdk

Permalink

class ScalaDeploymentsApi extends AnyRef

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

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

Instance Constructors

  1. new ScalaDeploymentsApi(deploymentsApi: DeploymentsApi)

    Permalink

    deploymentsApi

    the underlying Java SDK DeploymentsApi

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(deploymentId: String, options: Option[ScalaQueryOptions[Seq[AllocationListStub]]]): ServerQueryResponse[Seq[AllocationListStub]]

    Permalink

    Lists the allocations belonging to a deployment in the active region.

    Lists the allocations belonging to a deployment in the active region.

    deploymentId

    the ID of the deployment to list allocations for

    options

    options controlling how the request is performed

    See also

    GET /v1/deployment/<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 fail(deploymentId: String, options: Option[WriteOptions]): ServerResponse[DeploymentUpdateResponse]

    Permalink

    Fails a deployment in the active region.

    Fails a deployment in the active region.

    deploymentId

    the ID of the deployment to list allocations for

    options

    options controlling how the request is performed

    See also

    PUT /v1/deployment/fail/<ID>

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def info(deploymentId: String, options: Option[ScalaQueryOptions[Deployment]]): ServerQueryResponse[Deployment]

    Permalink

    Queries a deployment in the active region.

    Queries a deployment in the active region.

    deploymentId

    ID of the deployment to lookup

    options

    options controlling how the request is performed

    Annotations
    @throws( ... )
    See also

    GET /v1/deployment/{ID}

  14. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Lists deployments in the active region.

    Lists deployments in the active region.

    deploymentIdPrefix

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

    options

    options controlling how the request is performed

    See also

    GET /v1/deployments

  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. def pause(deploymentId: String, pause: Boolean, options: Option[WriteOptions]): ServerResponse[DeploymentUpdateResponse]

    Permalink

    Pauses or un-pauses a deployment in the active region.

    Pauses or un-pauses a deployment in the active region.

    deploymentId

    the ID of the deployment to list allocations for

    pause

    true if the deployment should be paused, false if it should be un-paused

    options

    options controlling how the request is performed

    See also

    PUT /v1/deployment/pause/<ID>

  20. def promote(deploymentId: String, groups: Option[Seq[String]] = None, options: Option[WriteOptions] = None): ServerResponse[DeploymentUpdateResponse]

    Permalink

    Promotes the canaries in the provided groups of a deployment in the active region.

    Promotes the canaries in the provided groups of a deployment in the active region.

    deploymentId

    the ID of the deployment to list allocations for

    groups

    when specified, only canaries in these groups will be promoted

    options

    options controlling how the request is performed

    See also

    PUT /v1/deployment/promote/<ID>

  21. def setAllocHealth(deploymentId: String, healthy: Seq[String], unhealthy: Seq[String], options: Option[WriteOptions] = None): ServerResponse[DeploymentUpdateResponse]

    Permalink

    Sets the health of allocations that are part of a deployment.

    Sets the health of allocations that are part of a deployment.

    deploymentId

    the ID of the deployment to list allocations for

    healthy

    ids of allocations to be set healthy

    unhealthy

    ids of allocations to be set unhealthy

    options

    options controlling how the request is performed

    See also

    PUT /v1/deployment/allocation-health/<ID>

  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped