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

  • 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

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

    • getInstancesMin

      public int getInstancesMin()

    • getSaveFailure

      public boolean getSaveFailure()

    • getTargetResourcePool

      public String getTargetResourcePool()

    • getTargetHost

      public String getTargetHost()

    • getHostSelectionMode

      public String getHostSelectionMode()

    • setHostSelectionMode

      @DataBoundSetter public void setHostSelectionMode(String hostSelectionMode)

    • getReconfigureStartTimeoutSeconds

      public int getReconfigureStartTimeoutSeconds()
      See Also:
      • reconfigureStartTimeoutSeconds

    • setReconfigureStartTimeoutSeconds

      @DataBoundSetter public void setReconfigureStartTimeoutSeconds(int reconfigureStartTimeoutSeconds)

    • 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)

    • getHostSelectionRequireCores

      public Boolean getHostSelectionRequireCores()
      Opt-in override of the cloud's default: only consider hosts with at least as many physical CPU cores as the VM has vCPUs. null (the default) inherits the cloud's setting; true/false override it for this call site.

    • setHostSelectionRequireCores

      @DataBoundSetter public void setHostSelectionRequireCores(Boolean hostSelectionRequireCores)

    • getHostSelectionRequireCoresAsString

      public String getHostSelectionRequireCoresAsString()
      For the classic config UI, where an unset ("inherit") value has to survive a round trip as an empty string; pipeline and JCasC callers should use getHostSelectionRequireCores().

    • setHostSelectionRequireCoresAsString

      @DataBoundSetter public void setHostSelectionRequireCoresAsString(String hostSelectionRequireCoresAsString)

    • getHostSelectionRequireMemory

      public Boolean getHostSelectionRequireMemory()
      Opt-in override of the cloud's default: only consider hosts with at least as much physical RAM as the VM is configured with. null (the default) inherits the cloud's setting; true/false override it for this call site.

    • setHostSelectionRequireMemory

      @DataBoundSetter public void setHostSelectionRequireMemory(Boolean hostSelectionRequireMemory)

    • getHostSelectionRequireMemoryAsString

      public String getHostSelectionRequireMemoryAsString()
      For the classic config UI, where an unset ("inherit") value has to survive a round trip as an empty string; pipeline and JCasC callers should use getHostSelectionRequireMemory().

    • setHostSelectionRequireMemoryAsString

      @DataBoundSetter public void setHostSelectionRequireMemoryAsString(String hostSelectionRequireMemoryAsString)

    • getHostSelectionRequireAvailableMemory

      public Boolean getHostSelectionRequireAvailableMemory()
      Opt-in override of the cloud's default: only consider hosts that currently have at least as much memory free as the VM is configured with, so it is not swapped by the hypervisor. null (the default) inherits the cloud's setting; true/false override it for this call site.

    • setHostSelectionRequireAvailableMemory

      @DataBoundSetter public void setHostSelectionRequireAvailableMemory(Boolean hostSelectionRequireAvailableMemory)

    • getHostSelectionRequireAvailableMemoryAsString

      public String getHostSelectionRequireAvailableMemoryAsString()
      For the classic config UI, where an unset ("inherit") value has to survive a round trip as an empty string; pipeline and JCasC callers should use getHostSelectionRequireAvailableMemory().

    • setHostSelectionRequireAvailableMemoryAsString

      @DataBoundSetter public void setHostSelectionRequireAvailableMemoryAsString(String hostSelectionRequireAvailableMemoryAsString)

    • getHostWeightFreeCpuMhz

      public String getHostWeightFreeCpuMhz()

    • setHostWeightFreeCpuMhz

      @DataBoundSetter public void setHostWeightFreeCpuMhz(String hostWeightFreeCpuMhz)

    • getHostWeightFreeCpuPercent

      public String getHostWeightFreeCpuPercent()

    • setHostWeightFreeCpuPercent

      @DataBoundSetter public void setHostWeightFreeCpuPercent(String hostWeightFreeCpuPercent)

    • getHostWeightFreeMemoryMB

      public String getHostWeightFreeMemoryMB()

    • setHostWeightFreeMemoryMB

      @DataBoundSetter public void setHostWeightFreeMemoryMB(String hostWeightFreeMemoryMB)

    • getHostWeightFreeMemoryPercent

      public String getHostWeightFreeMemoryPercent()

    • setHostWeightFreeMemoryPercent

      @DataBoundSetter public void setHostWeightFreeMemoryPercent(String hostWeightFreeMemoryPercent)

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

    • getReconfigureSteps

      public List<ReconfigureStep> getReconfigureSteps()

    • 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>