api

Type Members

1. trait ApiJsonProtocol extends CommonApiJsonProtocol with ContainerApiJsonProtocol with DeployApiJsonProtocol with MonitoringApiJsonProtocol

   

2. class AutoRequestIdFormat[T <: WithRequestId] extends RootJsonFormat[T]

   

3. trait CommonApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol

   

   JSON (de)serialization for the Common API requests and responses.

4. 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.

5. trait ContainerApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol with ContainerDefinitionJsonProtocol

   

   JSON (de)serialization for the Container API requests and responses.

6. 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.

7. 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.

8. 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.

9. 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.

10. sealed trait ContainerRequest extends WithRequestId

    

    The base interface for all requests related to Container API.

11. sealed trait ContainerResponse extends WithRequestId

    

    The base interface for all responses related to Container API.

12. 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.

13. 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.

14. 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.

15. 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.

16. trait DeployApiJsonProtocol extends DefaultJsonProtocol with RequestIdJsonProtocol with InstanceIdJsonProtocol

    

    JSON (de)serialization for the Deploy API requests and responses.

17. 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.

18. 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.

19. 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.

20. 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.

21. 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.

22. case class GetInstancesBy(roles: Set[String], containerName: Option[String], 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.

    requestId

    the optional request ID. If not specified a random ID will be generated.

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

    

    A response that contains an information about the requested intance.

    A response that contains an information about the requested intance. This is a result of the GetInstance operation.

    requestId

    the ID of the original request.

    info

    the information about the requested instance. See InstanceInfo.

24. 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.

25. sealed trait InstanceRequest extends WithRequestId

    

    The base interface for all requests related to Monitoring API.

26. sealed trait InstanceResponse extends WithRequestId

    

    The base interface for all responses related to Monitoring API.

27. 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.

28. 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.

29. trait MonitoringApiJsonProtocol extends DefaultJsonProtocol with InstanceIdJsonProtocol with RequestIdJsonProtocol with InstanceStatusJsonProtocol

    

    JSON (de)serialization for the Monitoring API requests and responses.

30. 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.

31. 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.

32. 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.

33. 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.

34. trait WithRequestId extends AnyRef

    

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