Package jetbrains.buildServer.clouds

Interface CloudImage

All Superinterfaces:

CloudErrorProvider

All Known Implementing Classes:

CloudStateHolder.ImageState, DummyCloudImage

public interface CloudImage
extends CloudErrorProvider

Image handle. Represent a virtual machine image. All instances of an image are considered to be identical machines with identical configurations

Since:

5.0

Method Summary

Modifier and Type	Method	Description
CloudInstance	findInstanceById(String id)	Finds instance by instanceId
Integer	getAgentPoolId()	Internal agent pool id associated with this cloud image.
String	getId()	Returns the identifier of this image, in the vendor-specific form.
Collection<? extends CloudInstance>	getInstances()	Returns all instances of the image.
default Integer	getInstancesLimit()	The maximum number of instances associated to the cloud image.
String	getName()
default Integer	getPriority()
default String	getProfileId()	Identifier of a cloud profile where this cloud image belongs.
default Integer	getRunningInstancesCount()	Returns the number running instances of the running image

Methods inherited from interface jetbrains.buildServer.clouds.CloudErrorProvider

getErrorInfo

Method Detail

getId

@NotNull
String getId()

Returns the identifier of this image, in the vendor-specific form.
Images with different ids are considered different images.

Must be unique within the profile.

Returns:

image identifier.

getName

@NotNull
String getName()

Returns:

human readable image name

getInstances

@NotNull
Collection<? extends CloudInstance> getInstances()

Returns all instances of the image. The method should either return an unmodifiable snapshot of the instances or a thread-safe collection.

Returns:

instances

getRunningInstancesCount

@Nullable
default Integer getRunningInstancesCount()

Returns the number running instances of the running image

Returns:

number of running instances. null if it's not able to calculate this number

Since:

2023.03

findInstanceById

@Nullable
CloudInstance findInstanceById(@NotNull
                               String id)

Finds instance by instanceId

Parameters:

id - id

Returns:

instance or null

getAgentPoolId

@Nullable
Integer getAgentPoolId()

Internal agent pool id associated with this cloud image.
If this feature is not implemented, the function must return null.
Must use CloudImageData.getAgentPoolId() if returns non-null value.

Returns:

internal pool id

Since:

10.0

getProfileId

@Nullable
default String getProfileId()

Identifier of a cloud profile where this cloud image belongs. Or null if this id is not available.

Returns:

see above

Since:

2022.02

getInstancesLimit

@Nullable
default Integer getInstancesLimit()

The maximum number of instances associated to the cloud image.

A positive number will represent the true limit of instances. Null will represent if the information is not available, undefined, or an unlimited number of instances is allowed.

Returns:

see above

Since:

2022.12

getPriority

@Nullable
default Integer getPriority()

Returns:

priority of the image

Since:

2023.11