com.elastisys.scale.cloudpool.api.restapi

Interface CloudPoolRestApi

All Known Implementing Classes:

CloudPoolRestApiImpl

@Consumes(value="application/json")
 @Produces(value="application/json")
public interface CloudPoolRestApi

The CloudPool REST API. For additional details, refer to the official cloud pool API documentation.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	attachMachine(String machineId) Attaches an already running machine instance to the pool, growing the pool with a new member.
javax.ws.rs.core.Response	detachMachine(String machineId, DetachMachineRequest request) Removes a member from the pool without terminating it.
javax.ws.rs.core.Response	getConfig() Retrieves the configuration currently set for the CloudPool.
javax.ws.rs.core.Response	getPool() Retrieves the current machine pool members.
javax.ws.rs.core.Response	getPoolSize() Returns the current size of the machine pool -- both in terms of the desired size and the actual size (as these may differ at any time).
javax.ws.rs.core.Response	getStatus() Retrieves the execution status for the cloud pool.
javax.ws.rs.core.Response	setConfig(com.google.gson.JsonObject configuration) Sets the configuration for the CloudPool.
javax.ws.rs.core.Response	setDesiredSize(SetDesiredSizeRequest request) Sets the desired number of machines in the machine pool.
javax.ws.rs.core.Response	setMembershipStatus(String machineId, SetMembershipStatusRequest request) Sets the membership status of a given pool member.
javax.ws.rs.core.Response	setServiceState(String machineId, SetServiceStateRequest request) Sets the service state of a given machine pool member.
javax.ws.rs.core.Response	start() Starts the cloud pool.
javax.ws.rs.core.Response	stop() Stops the cloud pool.
javax.ws.rs.core.Response	terminateMachine(String machineId, TerminateMachineRequest request) Terminates a particular machine pool member.

Method Detail

getConfig

@GET
 @Path(value="/config")
javax.ws.rs.core.Response getConfig()

Retrieves the configuration currently set for the CloudPool.

More details can be found in the official API documentation.

Returns:

A response message as per the cloud pool REST API.

setConfig

@POST
 @Path(value="/config")
javax.ws.rs.core.Response setConfig(com.google.gson.JsonObject configuration)

Sets the configuration for the CloudPool.

More details can be found in the official API documentation.

Parameters:

configuration - The (JSON) configuration document to set.

Returns:

A response message as per the cloud pool REST API.

start

@POST
 @Path(value="/start")
javax.ws.rs.core.Response start()

Starts the cloud pool.

This will set the cloud pool in an activated state where it will start to accept requests to query or modify the machine pool.

If the cloud pool has not been configured the method should fail. If the cloud pool is already started this is a no-op.

More details can be found in the official API documentation.

Returns:

A response message as per the cloud pool REST API.

stop

@POST
 @Path(value="/stop")
javax.ws.rs.core.Response stop()

Stops the cloud pool.

A stopped cloud pool is in a passivated state and will not accept any requests to query or modify the machine pool.

If the cloud pool is already in a stopped state this is a no-op.

More details can be found in the official API documentation.

Returns:

A response message as per the cloud pool REST API.

getStatus

@GET
 @Path(value="/status")
javax.ws.rs.core.Response getStatus()

Retrieves the execution status for the cloud pool.

More details can be found in the official API documentation.

Returns:

A response message as per the cloud pool REST API.

getPool

@GET
 @Path(value="/pool")
javax.ws.rs.core.Response getPool()

Retrieves the current machine pool members.

More details can be found in the official API documentation.

Returns:

A response message as per the cloud pool REST API.

setDesiredSize

@POST
 @Path(value="/pool/size")
javax.ws.rs.core.Response setDesiredSize(SetDesiredSizeRequest request)

Sets the desired number of machines in the machine pool. This method is asynchronous in that the method returns immediately without having carried out any required changes to the machine pool.

More details can be found in the official API documentation.

Parameters:

request - A SetDesiredSizeRequest.

Returns:

A response message as per the cloud pool REST API.

getPoolSize

@GET
 @Path(value="/pool/size")
javax.ws.rs.core.Response getPoolSize()

Returns the current size of the machine pool -- both in terms of the desired size and the actual size (as these may differ at any time).

More details can be found in the official API documentation.

Returns:

A response message as per the cloud pool REST API.

terminateMachine

@POST
 @Path(value="/pool/{machine}/terminate")
javax.ws.rs.core.Response terminateMachine(@PathParam(value="machine")
                                                                                           String machineId,
                                                                                           TerminateMachineRequest request)

Terminates a particular machine pool member. The caller can control if a replacement machine is to be provisioned.

More details can be found in the official API documentation.

Parameters:

machineId - The identifier of the machine to terminate.

request - A TerminateMachineRequest.

Returns:

A response message as per the cloud pool REST API.

detachMachine

@POST
 @Path(value="/pool/{machine}/detach")
javax.ws.rs.core.Response detachMachine(@PathParam(value="machine")
                                                                                     String machineId,
                                                                                     DetachMachineRequest request)

Removes a member from the pool without terminating it. The machine keeps running but is no longer considered a pool member and, therefore, needs to be managed independently. The caller can control if a replacement machine is to be provisioned.

More details can be found in the official API documentation.

Parameters:

machineId - The identifier of the machine to detach from the pool.

request - A DetachMachineRequest.

Returns:

A response message as per the cloud pool REST API.

attachMachine

@POST
 @Path(value="/pool/{machine}/attach")
javax.ws.rs.core.Response attachMachine(@PathParam(value="machine")
                                                                                     String machineId)

Attaches an already running machine instance to the pool, growing the pool with a new member. This operation implies that the desired size of the pool is incremented by one.

More details can be found in the official API documentation.

Parameters:

machineId - The identifier of the machine to attach to the pool.

Returns:

A response message as per the cloud pool REST API.

setServiceState

@POST
 @Path(value="/pool/{machine}/serviceState")
javax.ws.rs.core.Response setServiceState(@PathParam(value="machine")
                                                                                             String machineId,
                                                                                             SetServiceStateRequest request)

Sets the service state of a given machine pool member. Setting the service state does not have any functional implications on the pool member, but should be seen as way to supply operational information about the service running on the machine to third-party services (such as load balancers).

More details can be found in the official API documentation.

Parameters:

machineId - The machine whose service state is to be set.

request - A SetServiceStateRequest.

Returns:

A response message as per the cloud pool REST API.

setMembershipStatus

@POST
 @Path(value="/pool/{machine}/membershipStatus")
javax.ws.rs.core.Response setMembershipStatus(@PathParam(value="machine")
                                                                                                     String machineId,
                                                                                                     SetMembershipStatusRequest request)

Sets the membership status of a given pool member. The membership status for a machine can be set to protect the machine from being terminated (by setting its evictability status) and/or to mark a machine as being in need of replacement by flagging it as an inactive pool member.

More details can be found in the official API documentation.

Parameters:

machineId - The machine whose service state is to be set.

request - A SetMembershipStatusRequest.

Returns:

A response message as per the cloud pool REST API.