vSphereCloudSlaveTemplate (vSphere Plugin 2.27 API)

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 and Description

static class vSphereCloudSlaveTemplate.DescriptorImpl

Nested Classes
Modifier and Type	Class and Description
`static class`	`vSphereCloudSlaveTemplate.DescriptorImpl`

Field Summary

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

Constructor Summary

Constructors
Constructor and 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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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<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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 Detail

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 Detail

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()
```

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>

Class vSphereCloudSlaveTemplate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTTP_SCHEME

HTTPS_SCHEME

parent

Constructor Detail

vSphereCloudSlaveTemplate

Method Detail

getCloneNamePrefix

getMasterImageName

getUseSnapshot

getSnapshotName

getLinkedClone

getCluster

getResourcePool

getDatastore

getFolder

getCustomizationSpec

getTemplateDescription

getTemplateInstanceCap

getNumberOfExecutors

getRemoteFS

getLabelString

getMode

getForceVMLaunch

getWaitForVMTools

getLaunchDelay

getLimitedRunCount

getSaveFailure

getTargetResourcePool

getTargetHost

getCredentialsId

getNodeProperties

getGuestInfoProperties

getLabelSet

getParent

getLauncher

getRetentionStrategy

readResolve

provision

getDescriptor