Package org.jenkinsci.plugins.vsphere.tools

Enum Class HostSelectionWaitReason

java.lang.Object
java.lang.Enum<HostSelectionWaitReason>
org.jenkinsci.plugins.vsphere.tools.HostSelectionWaitReason
All Implemented Interfaces:
Serializable, Comparable<HostSelectionWaitReason>, Constable
public enum HostSelectionWaitReason extends Enum<HostSelectionWaitReason>
Why automatic host selection found no host to place a new VM on at the moment, which is when hostSelectionWaitSeconds comes into play. Passed to a pipeline's hostSelectionWaitNotification so that it can tell a situation that is likely to pass by itself (the hosts are merely busy) from one that needs somebody's attention (see isTransient()).

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BELOW_FREE_RESOURCE_LIMITS
    Hosts are usable, but every one has less free CPU/RAM than the configured limits demand.
    NO_HOST_FITS_VM_SIZE
    No usable host has enough physical cores or RAM for the VM, as the sizing requirements ask.
    NO_HOST_WITH_FREE_RAM_FOR_VM
    Hosts big enough for the VM exist, but none has the VM's memory size free right now.
    NO_USABLE_HOSTS
    Every host is disconnected, in maintenance mode, or not among the candidate hosts.
    NO_USAGE_STATISTICS
    No candidate host reports CPU/memory usage, so they cannot be told apart by load.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    failsWhenGivingUp()
    What happens if the wait is not enabled or runs out: true if the clone/deploy then fails (the free resource limits were set to be respected, so vCenter must not place the VM regardless), false if it is left to vCenter to place the VM, as it always was in the other situations.
    boolean
    isPersistent()
    The opposite of isTransient().
    boolean
    isTransient()
    True if the situation is assumed to pass by itself as the running workloads come and go (hosts are busy at the moment); false if it is assumed to persist until somebody changes something (hosts in maintenance, hosts that do not report usage, hosts too small for the VM).
    static HostSelectionWaitReason
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static HostSelectionWaitReason[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NO_USABLE_HOSTS

      public static final HostSelectionWaitReason NO_USABLE_HOSTS
      Every host is disconnected, in maintenance mode, or not among the candidate hosts.

    • NO_HOST_FITS_VM_SIZE

      public static final HostSelectionWaitReason NO_HOST_FITS_VM_SIZE
      No usable host has enough physical cores or RAM for the VM, as the sizing requirements ask.

    • NO_USAGE_STATISTICS

      public static final HostSelectionWaitReason NO_USAGE_STATISTICS
      No candidate host reports CPU/memory usage, so they cannot be told apart by load.

    • NO_HOST_WITH_FREE_RAM_FOR_VM

      public static final HostSelectionWaitReason NO_HOST_WITH_FREE_RAM_FOR_VM
      Hosts big enough for the VM exist, but none has the VM's memory size free right now.

    • BELOW_FREE_RESOURCE_LIMITS

      public static final HostSelectionWaitReason BELOW_FREE_RESOURCE_LIMITS
      Hosts are usable, but every one has less free CPU/RAM than the configured limits demand.

  • Method Details

    • values

      public static HostSelectionWaitReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HostSelectionWaitReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isTransient

      public boolean isTransient()
      True if the situation is assumed to pass by itself as the running workloads come and go (hosts are busy at the moment); false if it is assumed to persist until somebody changes something (hosts in maintenance, hosts that do not report usage, hosts too small for the VM).

    • isPersistent

      public boolean isPersistent()
      The opposite of isTransient().

    • failsWhenGivingUp

      public boolean failsWhenGivingUp()
      What happens if the wait is not enabled or runs out: true if the clone/deploy then fails (the free resource limits were set to be respected, so vCenter must not place the VM regardless), false if it is left to vCenter to place the VM, as it always was in the other situations.