Package org.jenkinsci.plugins

Class vSphereCloudSlaveTemplate

java.lang.Object

org.jenkinsci.plugins.vSphereCloudSlaveTemplate

All Implemented Interfaces:

Describable<vSphereCloudSlaveTemplate>

public class vSphereCloudSlaveTemplate
extends Object
implements Describable<vSphereCloudSlaveTemplate>

Author:

ksmith

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	vSphereCloudSlaveTemplate.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.cloudbees.plugins.credentials.domains.SchemeRequirement	HTTP_SCHEME
protected static final com.cloudbees.plugins.credentials.domains.SchemeRequirement	HTTPS_SCHEME
protected vSphereCloud	parent

Constructor Summary

Constructors

Constructor

Description

vSphereCloudSlaveTemplate(String cloneNamePrefix, String masterImageName, Boolean useSnapshot, String snapshotName, boolean linkedClone, String cluster, String resourcePool, String datastore, String folder, String customizationSpec, String templateDescription, int templateInstanceCap, int numberOfExecutors, String remoteFS, String labelString, Node.Mode mode, boolean forceVMLaunch, boolean waitForVMTools, int launchDelay, int limitedRunCount, boolean saveFailure, String targetResourcePool, String targetHost, String credentialsId, ComputerLauncher launcher, RetentionStrategy<?> retentionStrategy, List<? extends NodeProperty<?>> nodeProperties, List<? extends VSphereGuestInfoProperty> guestInfoProperties)

Method Summary

Modifier and Type	Method	Description
String	getCloneNamePrefix()
String	getCluster()
String	getCredentialsId()	Deprecated. credentials are now in the getLauncher() property.
String	getCustomizationSpec()
String	getDatastore()
Descriptor<vSphereCloudSlaveTemplate>	getDescriptor()
String	getFolder()
boolean	getForceVMLaunch()
List<? extends VSphereGuestInfoProperty>	getGuestInfoProperties()
Set<String>	getHostSelectionCandidates()	Canonical form, for pipeline/API/JCasC consumers.
String	getHostSelectionCandidatesAsString()	For the classic config UI textbox, and pipeline/JCasC callers that prefer a plain string.
String	getHostSelectionMode()
Set<LabelAtom>	getLabelSet()
String	getLabelString()
int	getLaunchDelay()
ComputerLauncher	getLauncher()
int	getLimitedRunCount()
boolean	getLinkedClone()
String	getMasterImageName()
Node.Mode	getMode()
List<? extends NodeProperty<?>>	getNodeProperties()
int	getNumberOfExecutors()
vSphereCloud	getParent()
String	getRemoteFS()
String	getResourcePool()
RetentionStrategy<?>	getRetentionStrategy()
boolean	getSaveFailure()
String	getSnapshotName()
String	getTargetHost()
String	getTargetResourcePool()
String	getTemplateDescription()
int	getTemplateInstanceCap()
boolean	getUseSnapshot()
boolean	getWaitForVMTools()
vSphereCloudProvisionedSlave	provision(String cloneName, TaskListener listener)
protected Object	readResolve()
void	setHostSelectionCandidates(Collection<String> hostSelectionCandidates)	Takes a flat list of individual host names - the natural shape for a pipeline or JCasC YAML caller that already has one.
void	setHostSelectionCandidatesAsString(String hostSelectionCandidatesCsv)
void	setHostSelectionMode(String hostSelectionMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HTTP_SCHEME

protected static final com.cloudbees.plugins.credentials.domains.SchemeRequirement HTTP_SCHEME

HTTPS_SCHEME

protected static final com.cloudbees.plugins.credentials.domains.SchemeRequirement HTTPS_SCHEME

parent

protected transient vSphereCloud parent

Constructor Details

vSphereCloudSlaveTemplate

@DataBoundConstructor
public vSphereCloudSlaveTemplate(String cloneNamePrefix,
 String masterImageName,
 Boolean useSnapshot,
 String snapshotName,
 boolean linkedClone,
 String cluster,
 String resourcePool,
 String datastore,
 String folder,
 String customizationSpec,
 String templateDescription,
 int templateInstanceCap,
 int numberOfExecutors,
 String remoteFS,
 String labelString,
 Node.Mode mode,
 boolean forceVMLaunch,
 boolean waitForVMTools,
 int launchDelay,
 int limitedRunCount,
 boolean saveFailure,
 String targetResourcePool,
 String targetHost,
 String credentialsId,
 ComputerLauncher launcher,
 RetentionStrategy<?> retentionStrategy,
 List<? extends NodeProperty<?>> nodeProperties,
 List<? extends VSphereGuestInfoProperty> guestInfoProperties)

Method Details

getCloneNamePrefix

public String getCloneNamePrefix()

getMasterImageName

public String getMasterImageName()

getUseSnapshot

public boolean getUseSnapshot()

getSnapshotName

public String getSnapshotName()

getLinkedClone

public boolean getLinkedClone()

getCluster

public String getCluster()

getResourcePool

public String getResourcePool()

getDatastore

public String getDatastore()

getFolder

public String getFolder()

getCustomizationSpec

public String getCustomizationSpec()

getTemplateDescription

public String getTemplateDescription()

getTemplateInstanceCap

public int getTemplateInstanceCap()

getNumberOfExecutors

public int getNumberOfExecutors()

getRemoteFS

public String getRemoteFS()

getLabelString

public String getLabelString()

getMode

public Node.Mode getMode()

getForceVMLaunch

public boolean getForceVMLaunch()

getWaitForVMTools

public boolean getWaitForVMTools()

getLaunchDelay

public int getLaunchDelay()

getLimitedRunCount

public int getLimitedRunCount()

getSaveFailure

public boolean getSaveFailure()

getTargetResourcePool

public String getTargetResourcePool()

getTargetHost

public String getTargetHost()

getHostSelectionMode

public String getHostSelectionMode()

setHostSelectionMode

@DataBoundSetter
public void setHostSelectionMode(String hostSelectionMode)

getHostSelectionCandidates

public Set<String> getHostSelectionCandidates()

Canonical form, for pipeline/API/JCasC consumers.

setHostSelectionCandidates

@DataBoundSetter
public void setHostSelectionCandidates(Collection<String> hostSelectionCandidates)

Takes a flat list of individual host names - the natural shape for a pipeline or JCasC YAML caller that already has one. See setHostSelectionCandidatesAsString(java.lang.String) for the comma-separated-string equivalent (used by the classic UI textbox). Both are kept as separate, concretely-typed properties rather than one that accepts either shape: Jenkins' JCasC introspection resolves exactly one configurator per property type, so a single Object-typed (or overloaded) setter is not reliably usable from YAML, even though pipeline's looser binding tolerates it.

getHostSelectionCandidatesAsString

public String getHostSelectionCandidatesAsString()

For the classic config UI textbox, and pipeline/JCasC callers that prefer a plain string. Blank means "inherit the cloud's default candidate list" (see vSphereCloud.getHostSelectionCandidates()); a single comma explicitly overrides to "no restriction at this call site" - see VSphereHostSelection.toAllowListString(java.util.Set<java.lang.String>).

setHostSelectionCandidatesAsString

@DataBoundSetter
public void setHostSelectionCandidatesAsString(String hostSelectionCandidatesCsv)

getCredentialsId

@Deprecated
public String getCredentialsId()

Deprecated.

credentials are now in the getLauncher() property.

Gets the old (deprecated) credentialsId field.

Returns:

the old, deprecated, credentialsId field.

getNodeProperties

public List<? extends NodeProperty<?>> getNodeProperties()

getGuestInfoProperties

public List<? extends VSphereGuestInfoProperty> getGuestInfoProperties()

getLabelSet

public Set<LabelAtom> getLabelSet()

getParent

public vSphereCloud getParent()

getLauncher

public ComputerLauncher getLauncher()

getRetentionStrategy

public RetentionStrategy<?> getRetentionStrategy()

readResolve

protected Object readResolve()

provision

public vSphereCloudProvisionedSlave provision(String cloneName,
 TaskListener listener)
                                       throws VSphereException,
Descriptor.FormException,
IOException,
InterruptedException

Throws:

VSphereException

Descriptor.FormException

IOException

InterruptedException

getDescriptor

public Descriptor<vSphereCloudSlaveTemplate> getDescriptor()

Specified by:

getDescriptor in interface Describable<vSphereCloudSlaveTemplate>