Package org.jenkinsci.plugins.vsphere.builders

Class Deploy

java.lang.Object

org.jenkinsci.plugins.vsphere.VSphereBuildStep

org.jenkinsci.plugins.vsphere.builders.Deploy

All Implemented Interfaces:

ExtensionPoint, Describable<VSphereBuildStep>, BuildStep, SimpleBuildStep

public class Deploy
extends VSphereBuildStep
implements SimpleBuildStep

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Deploy.DeployDescriptor

Nested classes/interfaces inherited from class org.jenkinsci.plugins.vsphere.VSphereBuildStep

VSphereBuildStep.VSphereBuildStepDescriptor

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from class org.jenkinsci.plugins.vsphere.VSphereBuildStep

sourceCloud, vsphere

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
Deploy(String template, String clone, boolean linkedClone, String resourcePool, String cluster, String datastore, String folder, String customizationSpec, Integer timeoutInSeconds, boolean powerOn)

Method Summary

Modifier and Type	Method	Description
String	getClone()
String	getCluster()
String	getCustomizationSpec()
String	getDatastore()
String	getFolder()
String	getHost()
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()
String	getIP()
Action	getProjectAction(AbstractProject<?,?> abstractProject)
Collection<? extends Action>	getProjectActions(AbstractProject<?,?> abstractProject)
BuildStepMonitor	getRequiredMonitorService()
String	getResourcePool()
String	getTemplate()
int	getTimeoutInSeconds()
boolean	isLinkedClone()
boolean	isPowerOn()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
void	perform(Run<?,?> run, FilePath filePath, Launcher launcher, TaskListener listener)
boolean	prebuild(AbstractBuild<?,?> abstractBuild, BuildListener buildListener)
void	setHost(String host)
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 org.jenkinsci.plugins.vsphere.VSphereBuildStep

all, allowDelete, getDescriptor, getSourceCloud, getVsphere, setSourceCloud, setVsphere

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

Deploy

@DataBoundConstructor
public Deploy(String template,
 String clone,
 boolean linkedClone,
 String resourcePool,
 String cluster,
 String datastore,
 String folder,
 String customizationSpec,
 Integer timeoutInSeconds,
 boolean powerOn)
       throws VSphereException

Throws:

VSphereException

Method Details

getTemplate

public String getTemplate()

getClone

public String getClone()

isLinkedClone

public boolean isLinkedClone()

getCluster

public String getCluster()

getResourcePool

public String getResourcePool()

getDatastore

public String getDatastore()

getFolder

public String getFolder()

getCustomizationSpec

public String getCustomizationSpec()

isPowerOn

public boolean isPowerOn()

getTimeoutInSeconds

public int getTimeoutInSeconds()

getHost

public String getHost()

setHost

@DataBoundSetter
public void setHost(String host)

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)

getIP

public String getIP()

Overrides:

getIP in class VSphereBuildStep

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath filePath,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Specified by:

perform in class VSphereBuildStep

Throws:

InterruptedException

IOException

prebuild

public boolean prebuild(AbstractBuild<?,?> abstractBuild,
 BuildListener buildListener)

Specified by:

prebuild in interface BuildStep

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)

Specified by:

perform in interface BuildStep

Specified by:

perform in class VSphereBuildStep

getProjectAction

public Action getProjectAction(AbstractProject<?,?> abstractProject)

Specified by:

getProjectAction in interface BuildStep

getProjectActions

public Collection<? extends Action> getProjectActions(AbstractProject<?,?> abstractProject)

Specified by:

getProjectActions in interface BuildStep

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep