api

Type Members

case class ActorLaunchContext(name: String, fqn: String) extends Product with Serializable

A launch context that represents an actor that has to be launched in container.
A launch context that represents an actor that has to be launched in container.
name
the name of the actor.
fqn
the full qualified name of the actor, i.e. "com.myproject.MyActor".
trait ApiJsonProtocol extends CommonApiJsonProtocol with ContainerApiJsonProtocol with DeployApiJsonProtocol with MonitoringApiJsonProtocol
class AutoRequestIdFormat[T <: WithRequestId] extends RootJsonFormat[T] with RequestIdJsonProtocol
trait CommonApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol

JSON (de)serialization for the Common API requests and responses.
case class ContainerAlreadyExists(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

A response that indicates that the container with the given name already exists.
A response that indicates that the container with the given name already exists. This is one of the possible responses to the CreateContainer request.
requestId
the ID of the original request.
name
the name of the container.
trait ContainerApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol with ContainerDefinitionJsonProtocol

JSON (de)serialization for the Container API requests and responses.
case class ContainerCreated(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

A response that indicates a successful creation of the container.
A response that indicates a successful creation of the container. This is a result of the CreateContainer operation.
requestId
the ID of the original request.
name
the name of the created container.
case class ContainerDefinition(name: String, cpus: Int, memory: Int, actors: Seq[ActorLaunchContext], jvmArgs: Seq[String] = Seq.empty, jvmProperties: Map[String, String] = Map.empty, environment: Map[String, String] = Map.empty) extends Product with Serializable

Contains all the necessary information to launch a new instance in container.
Contains all the necessary information to launch a new instance in container.
name
the unique name of the container.
cpus
the number of CPUs that will be allocated for each instance of this container.
memory
the amount of RAM in MB that will be allocated for each instance of this container.
actors
the list of actors that will be deployed. See ActorLaunchContext.
jvmArgs
the list of JVM arguments that will be passed to each instance of this container. I.e. "-Xmx1g"
jvmProperties
the map of JVM properties that will be passed to each instance of this container. This map reflects the behaviour of the "-Dproperty=value" JVM argument.
environment
the map of environment variables that will passed to each instance of this container. The key of the map is an environment variable name and the value is a variable's value.
trait ContainerDefinitionJsonProtocol extends DefaultJsonProtocol
case class ContainerDeleted(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

A response that indicates a successful removing of the container.
A response that indicates a successful removing of the container. This is a result of the DeleteContainer operation.
requestId
the ID of the original request.
name
the name of the removed container.
case class ContainerGetResult(requestId: RequestId, container: ContainerDefinition) extends ContainerResponse with Product with Serializable

A result of the GetContainer request.
A result of the GetContainer request. Contains the definition of the request container.
requestId
the ID of the original request.
container
the definition of the requested container.
case class ContainerNotFound(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

A response that indicates that the requested container was not found.
A response that indicates that the requested container was not found.
requestId
the ID of the original request.
name
the name of the requested container.
sealed trait ContainerRequest extends WithRequestId

The base interface for all requests related to Container API.
sealed trait ContainerResponse extends WithRequestId

The base interface for all responses related to Container API.
case class ContainerUpdated(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

A response that indicates a successful update of the container.
A response that indicates a successful update of the container. This is a result of the UpdateContainer operation.
requestId
the ID of the original request.
name
the name of the updated container.
case class ContainersList(requestId: RequestId, containers: Seq[String]) extends ContainerResponse with Product with Serializable

A response that contains the list of existing container names as a result of the GetContainers request.
A response that contains the list of existing container names as a result of the GetContainers request.
requestId
the ID of the original request.
containers
the list of container names.
case class CreateContainer(container: ContainerDefinition, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

A container creation request.
A container creation request. The possible responses are:
- ContainerCreated - if the given container was created successfully.
- ContainerAlreadyExists - if a container with the same name already exists.
- OperationFailed - if other error occurred.
container
the container definition. See ContainerDefinition.
requestId
the optional request ID. If not specified a random ID will be generated.
case class DeleteContainer(name: String, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

A container delete request.
A container delete request. The possible responses are:
- ContainerDeleted - if the given container was deleted successfully.
- ContainerNotFound - if the container with the given name was not found.
- OperationFailed - if other error occurred.
name
the name of the container that has to be deleted.
requestId
the optional request ID. If not specified a random ID will be generated.
trait DeployApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol with InstanceIdJsonProtocol

JSON (de)serialization for the Deploy API requests and responses.
case class DeployContainer(name: String, quantity: Int, jvmArgs: Option[Seq[String]] = None, properties: Option[Map[String, String]] = None, requestId: RequestId = RequestId()) extends WithRequestId with Product with Serializable

A request to deploy (launch) new instance(s) of the given container.
A request to deploy (launch) new instance(s) of the given container. The possible responses are:
- SubmittedInstances - if the deployment attempt was successful.
- ContainerNotFound - if the container with requested name was not found.
- OperationFailed - if error occurred.
name
the name of the container that will be deployed.
quantity
the number of instances that will be deployed.
jvmArgs
the list of JVM arguments that override/extend JVM arguments from the container definition.
properties
the map of properties, where the key - is a property name, and the value is a property value. Overrides/extends properties from the container definition.
requestId
the optional request ID. If not specified a random ID will be generated.
case class GetContainer(name: String, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

A request to retrieve the definition of the container with the given name.
A request to retrieve the definition of the container with the given name. The possible responses are:
- ContainerGetResult - contains definition of the requested container.
- ContainerNotFound - if the container with the given name was not found.
- OperationFailed - if other error occurred.
name
the container's name
requestId
the optional request ID. If not specified a random ID will be generated.
case class GetContainers(requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

A request to retrieve names of all existing containers.
A request to retrieve names of all existing containers. The possible responses are:
- ContainersList - contains list of existing container names.
- OperationFailed - if error occurred.
requestId
the optional request ID. If not specified a random ID will be generated.
case class GetInstance(instanceId: InstanceId, requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

A request to retrieve the information about the instance using its ID.
A request to retrieve the information about the instance using its ID. The possible responses are:
- InstanceInfoResponse - contains information about the requested instance.
- InstanceNotFound - if the request instance was not found.
- OperationFailed - if other error occurred.
instanceId
the ID of the instance.
requestId
the optional request ID. If not specified a random ID will be generated.
case class GetInstances(requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

A request to retrieve the IDs of all existing instances.
A request to retrieve the IDs of all existing instances. The possible responses are:
- InstancesList - contains the list of existing instances.
- OperationFailed - if error occurred.
requestId
the optional request ID. If not specified a random ID will be generated.
case class GetInstancesBy(roles: Set[String], containerName: Option[String], statuses: Set[InstanceStatus], requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

A request to find the instance IDs that match specific requirements.
A request to find the instance IDs that match specific requirements. The possible responses are:
- InstancesList - contains the list of requested instances.
- OperationFailed - if error occurred.
roles
the list of roles the requested instance must have. An empty list means any roles. Note: an instance must include all roles enumerated in this list in order to meet the search requirements.
containerName
the name of the container the requested instance must belong to. If not specified instance with any container will match.
statuses
the list of desired statuses.
requestId
the optional request ID. If not specified a random ID will be generated.
final case class InstanceAddress(protocol: String, system: String, host: Option[String], port: Option[Int]) extends Product with Serializable
case class InstanceId(containerName: String, uuid: UUID) extends Product with Serializable

Represents a unique ID of the instance.
Represents a unique ID of the instance.
containerName
the name of the container this instance belongs to.
uuid
the unique ID of the instance.
trait InstanceIdJsonProtocol extends DefaultJsonProtocol
case class InstanceInfo extends Product with Serializable

A complete information about the instance.
trait InstanceInfoJsonProtocol extends DefaultJsonProtocol with InstanceIdJsonProtocol
case class InstanceInfoResponse(requestId: RequestId, info: InstanceInfo) extends InstanceResponse with Product with Serializable

A response that contains an information about the requested instance.
A response that contains an information about the requested instance. This is a result of the GetInstance operation.
requestId
the ID of the original request.
info
the information about the requested instance. See InstanceInfo.
case class InstanceNotFound(requestId: RequestId, instanceId: InstanceId) extends InstanceResponse with Product with Serializable

A response that indicates that the request instance was not found.
A response that indicates that the request instance was not found.
requestId
the ID of the original request.
instanceId
the requested instance ID.
sealed trait InstanceRequest extends WithRequestId

The base interface for all requests related to Monitoring API.
sealed trait InstanceResponse extends WithRequestId

The base interface for all responses related to Monitoring API.
sealed trait InstanceStatus extends AnyRef

Represents a status of the instance.
case class InstanceTerminated(requestId: RequestId, instanceId: InstanceId) extends InstanceResponse with Product with Serializable

A response that indicates the successful termination of the instance.
A response that indicates the successful termination of the instance. This is a result of the TerminateInstance operation.
requestId
the ID of the original request.
instanceId
the ID of the terminated intance.
final case class InstanceUniqueAddress(address: InstanceAddress, longUid: Long) extends Product with Serializable
case class InstancesList(requestId: RequestId, instanceIds: Seq[InstanceId]) extends InstanceResponse with Product with Serializable

A response that contains the list of IDs of existing instances.
A response that contains the list of IDs of existing instances. This is a result of the GetInstances operation.
requestId
the ID of the original request.
instanceIds
the list of instance IDs.
trait MonitoringApiJsonProtocol extends DefaultJsonProtocol with InstanceIdJsonProtocol with RequestIdJsonProtocol with InstanceInfoJsonProtocol

JSON (de)serialization for the Monitoring API requests and responses.
case class OperationFailed(requestId: RequestId, cause: Throwable) extends WithRequestId with Product with Serializable

A response message that represents an arbitrary general error.
A response message that represents an arbitrary general error. It's usually used when some unexpected or unhandled error occurs.
requestId
the ID of the original request that caused an operation that failed.
cause
the reason of the failure.
case class RequestId(uuid: UUID) extends Product with Serializable

The unique ID of the API request.
The unique ID of the API request.
uuid
the unique ID.
trait RequestIdJsonProtocol extends DefaultJsonProtocol
case class SubmittedInstances(requestId: RequestId, containerName: String, instanceIds: Seq[InstanceId]) extends WithRequestId with Product with Serializable

A response that indicates a successful deployment of new instances.
A response that indicates a successful deployment of new instances. Note: this response only indicates the successful allocation of containers and doesn't imply that actors are launched successfully too.
requestId
the ID of the original request.
containerName
the name of the container that has been deployed.
instanceIds
the list of IDs of newly launched instances.
case class TerminateInstance(instanceId: InstanceId, requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

A request to terminate a running instance.
A request to terminate a running instance. The possible responses are:
- InstanceTerminated - of the instance has been terminated successfully.
- OperationFailed - if error occurred.
instanceId
the ID of the instance that has to be terminated.
requestId
the optional request ID. If not specified a random ID will be generated.
case class UpdateContainer(container: ContainerDefinition, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

A container update request.
A container update request. The possible responses are:
- ContainerUpdated - if the given container was updated successfully.
- ContainerNotFound - if the container with the given name was not found.
- OperationFailed - if other error occurred.
container
the updated definition of the existing container. See ContainerDefinition.
requestId
the optional request ID. If not specified a random ID will be generated.
trait WithRequestId extends AnyRef

The base interface for all messages that include unique request ID.

Value Members

object ApiJsonProtocol extends ApiJsonProtocol
object AutoRequestIdFormat
object CommonApiJsonProtocol extends CommonApiJsonProtocol
object ContainerDefinitionJsonProtocol extends ContainerDefinitionJsonProtocol
object Heartbeat extends Product with Serializable

A heartbeat message to prevent Akkeeper Master from termination.
object InstanceDeployFailed extends InstanceStatus with Product with Serializable
object InstanceDeploying extends InstanceStatus with Product with Serializable
object InstanceId extends Serializable
object InstanceIdJsonProtocol extends InstanceIdJsonProtocol
object InstanceInfo extends Serializable
object InstanceInfoJsonProtocol extends InstanceInfoJsonProtocol
object InstanceLaunching extends InstanceStatus with Product with Serializable
object InstanceStatus
object InstanceUnreachable extends InstanceStatus with Product with Serializable
object InstanceUp extends InstanceStatus with Product with Serializable
object RequestId extends Serializable
object RequestIdJsonProtocol extends RequestIdJsonProtocol
object TerminateMaster extends Product with Serializable

A command that terminates the Akkeeper Master instance.

package api

Type Members

case class ActorLaunchContext(name: String, fqn: String) extends Product with Serializable

trait ApiJsonProtocol extends CommonApiJsonProtocol with ContainerApiJsonProtocol with DeployApiJsonProtocol with MonitoringApiJsonProtocol

class AutoRequestIdFormat[T <: WithRequestId] extends RootJsonFormat[T] with RequestIdJsonProtocol

trait CommonApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol

case class ContainerAlreadyExists(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

trait ContainerApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol with ContainerDefinitionJsonProtocol

case class ContainerCreated(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

case class ContainerDefinition(name: String, cpus: Int, memory: Int, actors: Seq[ActorLaunchContext], jvmArgs: Seq[String] = Seq.empty, jvmProperties: Map[String, String] = Map.empty, environment: Map[String, String] = Map.empty) extends Product with Serializable

trait ContainerDefinitionJsonProtocol extends DefaultJsonProtocol

case class ContainerDeleted(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

case class ContainerGetResult(requestId: RequestId, container: ContainerDefinition) extends ContainerResponse with Product with Serializable

case class ContainerNotFound(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

sealed trait ContainerRequest extends WithRequestId

sealed trait ContainerResponse extends WithRequestId

case class ContainerUpdated(requestId: RequestId, name: String) extends ContainerResponse with Product with Serializable

case class ContainersList(requestId: RequestId, containers: Seq[String]) extends ContainerResponse with Product with Serializable

case class CreateContainer(container: ContainerDefinition, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

case class DeleteContainer(name: String, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

trait DeployApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol with InstanceIdJsonProtocol

case class DeployContainer(name: String, quantity: Int, jvmArgs: Option[Seq[String]] = None, properties: Option[Map[String, String]] = None, requestId: RequestId = RequestId()) extends WithRequestId with Product with Serializable

case class GetContainer(name: String, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

case class GetContainers(requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

case class GetInstance(instanceId: InstanceId, requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

case class GetInstances(requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

case class GetInstancesBy(roles: Set[String], containerName: Option[String], statuses: Set[InstanceStatus], requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

final case class InstanceAddress(protocol: String, system: String, host: Option[String], port: Option[Int]) extends Product with Serializable

case class InstanceId(containerName: String, uuid: UUID) extends Product with Serializable

trait InstanceIdJsonProtocol extends DefaultJsonProtocol

case class InstanceInfo extends Product with Serializable

trait InstanceInfoJsonProtocol extends DefaultJsonProtocol with InstanceIdJsonProtocol

case class InstanceInfoResponse(requestId: RequestId, info: InstanceInfo) extends InstanceResponse with Product with Serializable

case class InstanceNotFound(requestId: RequestId, instanceId: InstanceId) extends InstanceResponse with Product with Serializable

sealed trait InstanceRequest extends WithRequestId

sealed trait InstanceResponse extends WithRequestId

sealed trait InstanceStatus extends AnyRef

case class InstanceTerminated(requestId: RequestId, instanceId: InstanceId) extends InstanceResponse with Product with Serializable

final case class InstanceUniqueAddress(address: InstanceAddress, longUid: Long) extends Product with Serializable

case class InstancesList(requestId: RequestId, instanceIds: Seq[InstanceId]) extends InstanceResponse with Product with Serializable

trait MonitoringApiJsonProtocol extends DefaultJsonProtocol with InstanceIdJsonProtocol with RequestIdJsonProtocol with InstanceInfoJsonProtocol

case class OperationFailed(requestId: RequestId, cause: Throwable) extends WithRequestId with Product with Serializable

case class RequestId(uuid: UUID) extends Product with Serializable

trait RequestIdJsonProtocol extends DefaultJsonProtocol

case class SubmittedInstances(requestId: RequestId, containerName: String, instanceIds: Seq[InstanceId]) extends WithRequestId with Product with Serializable

case class TerminateInstance(instanceId: InstanceId, requestId: RequestId = RequestId()) extends InstanceRequest with Product with Serializable

case class UpdateContainer(container: ContainerDefinition, requestId: RequestId = RequestId()) extends ContainerRequest with Product with Serializable

trait WithRequestId extends AnyRef

Value Members

object ApiJsonProtocol extends ApiJsonProtocol

object AutoRequestIdFormat

object CommonApiJsonProtocol extends CommonApiJsonProtocol

object ContainerDefinitionJsonProtocol extends ContainerDefinitionJsonProtocol

object Heartbeat extends Product with Serializable

object InstanceDeployFailed extends InstanceStatus with Product with Serializable

object InstanceDeploying extends InstanceStatus with Product with Serializable

object InstanceId extends Serializable

object InstanceIdJsonProtocol extends InstanceIdJsonProtocol

object InstanceInfo extends Serializable

object InstanceInfoJsonProtocol extends InstanceInfoJsonProtocol

object InstanceLaunching extends InstanceStatus with Product with Serializable

object InstanceStatus

object InstanceUnreachable extends InstanceStatus with Product with Serializable

object InstanceUp extends InstanceStatus with Product with Serializable

object RequestId extends Serializable

object RequestIdJsonProtocol extends RequestIdJsonProtocol

object TerminateMaster extends Product with Serializable

Ungrouped