Package jetbrains.buildServer.clouds

Interface CloudClientEx

All Superinterfaces:

CloudClient, CloudErrorProvider

All Known Implementing Classes:

BrokenClient, CloudClientCanStartProxy, DisposingCloudClientProxy, DummyCloudClient, ReadonlyClient

public interface CloudClientEx
extends CloudClient

Control for cloud client lifecycle

Since:

5.0

Method Summary

Modifier and Type	Method	Description
default void	dispose()	Notifies client that it is no longer needed, This is a good time to release all resources allocated to implement the client
default void	restartInstance(CloudInstance instance)	Restarts instance if possible
CloudInstance	startNewInstance(CloudImage image, CloudInstanceUserData tag)	Starts a new virtual machine instance
void	terminateInstance(CloudInstance instance)	Terminates instance.

Methods inherited from interface jetbrains.buildServer.clouds.CloudClient

canStartNewInstance, canStartNewInstanceWithDetails, findImageById, findInstanceByAgent, generateAgentName, getErrorInfo, getImages, getInstancesLimit, isInitialized

Method Detail

startNewInstance

@NotNull
CloudInstance startNewInstance(@NotNull
                               CloudImage image,
                               @NotNull
                               CloudInstanceUserData tag)
                        throws QuotaException

Starts a new virtual machine instance

Parameters:

image - image to start instance

tag - portion of agent setup-replated data.

Returns:

just started instance handle.

Throws:

QuotaException - if start can not be performed due to a quota lack

restartInstance

default void restartInstance(@NotNull
                             CloudInstance instance)

Restarts instance if possible

Parameters:

instance - instance to apply action to

terminateInstance

void terminateInstance(@NotNull
                       CloudInstance instance)

Terminates instance.

Parameters:

instance - instance to apply action to

dispose

default void dispose()

Notifies client that it is no longer needed, This is a good time to release all resources allocated to implement the client