Uses of Class
org.jenkinsci.plugins.vsphere.tools.HostSelectionOptions

Packages that use HostSelectionOptions

Package	Description
org.jenkinsci.plugins
org.jenkinsci.plugins.vsphere.tools

Uses of HostSelectionOptions in org.jenkinsci.plugins

Methods in org.jenkinsci.plugins that return HostSelectionOptions

Modifier and Type	Method	Description
static HostSelectionOptions	vSphereCloud.hostSelectionOptions(vSphereCloud cloud, Boolean requireCores, Boolean requireMemory)	Resolves the host selection refinements for one call site: the cloud's own defaults (or none, if there is no cloud), overridden by whatever the call site set explicitly.
static HostSelectionOptions	vSphereCloud.hostSelectionOptions(vSphereCloud cloud, Boolean requireCores, Boolean requireMemory, Boolean requireAvailableMemory)	As above, also for the "enough memory free right now" requirement.
static HostSelectionOptions	vSphereCloud.hostSelectionOptions(vSphereCloud cloud, Boolean requireCores, Boolean requireMemory, Boolean requireAvailableMemory, HostWeights weightsOverride)	As above, also with the host weights a call site set for itself: if weightsOverride is not null it replaces the cloud's weights as a whole, else the cloud's apply.
static HostSelectionOptions	vSphereCloud.hostSelectionOptions(vSphereCloud cloud, Boolean requireCores, Boolean requireMemory, Boolean requireAvailableMemory, HostWeights weightsOverride, Long waitSecondsOverride)	As above, also with how long the call site is willing to wait for a host within the cloud's free resource limits: if waitSecondsOverride is not null it replaces the cloud's wait time.
static HostSelectionOptions	vSphereCloud.hostSelectionOptions(vSphereCloud cloud, Boolean requireCores, Boolean requireMemory, Boolean requireAvailableMemory, HostWeights weightsOverride, Long waitSecondsOverride, HostLimits limitsOverride)	As above, also with the free resource limits a call site set for itself: if limitsOverride is not null it replaces the cloud's limits as a whole, else the cloud's apply.
static HostSelectionOptions	vSphereCloud.hostSelectionOptions(vSphereCloud cloud, Boolean requireCores, Boolean requireMemory, Boolean requireAvailableMemory, HostWeights weightsOverride, Long waitSecondsOverride, HostLimits limitsOverride, Boolean folderFollowsHostOverride)	As above, also with whether the call site wants the clone's default folder to follow the host chosen for it: if folderFollowsHostOverride is not null it replaces the cloud's setting.

Uses of HostSelectionOptions in org.jenkinsci.plugins.vsphere.tools

Fields in org.jenkinsci.plugins.vsphere.tools declared as HostSelectionOptions

Modifier and Type	Field	Description
static final HostSelectionOptions	HostSelectionOptions.NONE	No refinements: the original behaviour.

Methods in org.jenkinsci.plugins.vsphere.tools that return HostSelectionOptions

Modifier and Type	Method	Description
HostSelectionOptions	HostSelectionOptions.withFolderFollowsHost(boolean folderFollowsHost)	Same options, but if no folder is given for the clone, put it in the folder of its source with the source's host name replaced by the name of the host chosen for the clone (see HostFolderPath), if there is such a folder.
HostSelectionOptions	HostSelectionOptions.withLimits(HostLimits limits)	Same options, keeping hosts with less free resources than these limits off the candidate list.
HostSelectionOptions	HostSelectionOptions.withScoreDeviation(double scoreDeviation)	Same options, choosing at random among the hosts scoring within this fraction (0..1) of the best one; a negative number always takes the single top host.
HostSelectionOptions	HostSelectionOptions.withScoreDeviationOverride(Double scoreDeviation)	As withScoreDeviation(double), but a null (not set at the call site) keeps the current value.
HostSelectionOptions	HostSelectionOptions.withVmSize(Integer vmCpus, Long vmMemoryMB)	Same options, but telling the host size checks to compare against this vCPU count and memory size (null: unknown, use the source VM's) instead of the source VM's own - for VMs that are known to be resized right after being cloned.
HostSelectionOptions	HostSelectionOptions.withWaitListener(HostSelectionOptions.Listener waitListener, boolean ignoreErrors)	Same options, telling this listener whenever no host is available at the moment, right after that is logged.
HostSelectionOptions	HostSelectionOptions.withWaitSeconds(long waitSeconds)	Same options, but if the limits (or nothing else) leave no host, wait up to this many seconds for one to free up: 0 does not wait, a negative number (VSphereHostSelection.WAIT_FOREVER) waits for as long as it takes.
HostSelectionOptions	HostSelectionOptions.withWeights(HostWeights weights)	Same options, ranking the candidate hosts with these weights.

Methods in org.jenkinsci.plugins.vsphere.tools with parameters of type HostSelectionOptions

Modifier and Type	Method	Description
void	VSphere.cloneOrDeployVm(String cloneName, String sourceName, boolean linkedClone, String resourcePoolName, String cluster, String datastoreName, String folderName, boolean useCurrentSnapshot, String namedSnapshot, boolean powerOn, Map<String,String> extraConfigParameters, String customizationSpec, String host, String hostSelectionMode, Set<String> hostSelectionCandidates, HostSelectionOptions hostSelectionOptions, PrintStream jLogger)	As the overload without them, plus two opt-in checks on top of hostSelectionMode's candidate list, both comparing the VM's configuration with each host's total physical capacity (not what is currently free):
void	VSphere.cloneOrDeployVm(String cloneName, String sourceName, boolean linkedClone, String resourcePoolName, String cluster, String datastoreName, String folderName, boolean useCurrentSnapshot, String namedSnapshot, boolean powerOn, Map<String,String> extraConfigParameters, String customizationSpec, String host, String hostSelectionMode, Set<String> hostSelectionCandidates, HostSelectionOptions hostSelectionOptions, VmSize vmSize, PrintStream jLogger)	As the overload without them, plus the size to create the VM with.
void	VSphere.cloneVm(String cloneName, String sourceName, boolean linkedClone, String resourcePoolName, String cluster, String datastoreName, String folderName, boolean powerOn, String customizationSpec, String host, String hostSelectionMode, Set<String> hostSelectionCandidates, HostSelectionOptions hostSelectionOptions, PrintStream jLogger)	As the overload without them, plus the opt-in VM-size checks described at VSphere.cloneOrDeployVm(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, boolean, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.io.PrintStream) for hostSelectionOptions.
void	VSphere.cloneVm(String cloneName, String sourceName, boolean linkedClone, String resourcePoolName, String cluster, String datastoreName, String folderName, boolean powerOn, String customizationSpec, String host, String hostSelectionMode, Set<String> hostSelectionCandidates, HostSelectionOptions hostSelectionOptions, VmSize vmSize, PrintStream jLogger)	As the overload without them, plus a vCPU count and memory size (MB) to create the VM with in the same operation, instead of reconfiguring it afterwards; see VSphere.cloneOrDeployVm(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, boolean, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.io.PrintStream).
void	VSphere.deployVm(String cloneName, String sourceName, boolean linkedClone, String resourcePoolName, String cluster, String datastoreName, String folderName, boolean powerOn, String customizationSpec, String host, String hostSelectionMode, Set<String> hostSelectionCandidates, HostSelectionOptions hostSelectionOptions, PrintStream jLogger)	As the overload without them, plus the opt-in VM-size checks described at VSphere.cloneOrDeployVm(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, boolean, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.io.PrintStream) for hostSelectionOptions.
void	VSphere.deployVm(String cloneName, String sourceName, boolean linkedClone, String resourcePoolName, String cluster, String datastoreName, String folderName, boolean powerOn, String customizationSpec, String host, String hostSelectionMode, Set<String> hostSelectionCandidates, HostSelectionOptions hostSelectionOptions, VmSize vmSize, PrintStream jLogger)	As the overload without them, plus a vCPU count and memory size (MB) to create the VM with in the same operation, instead of reconfiguring it afterwards; see VSphere.cloneOrDeployVm(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String, boolean, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.io.PrintStream).