Package com.morpheusdata.request

Class RemoveHostRequest

java.lang.Object
com.morpheusdata.request.RemoveHostRequest
public class RemoveHostRequest extends Object
Request object for removing a host via MorpheusComputeServerService.removeHost(com.morpheusdata.model.ComputeServer, com.morpheusdata.request.RemoveHostRequest).
Since:
1.4.2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    boolean
    force
    When true, force the removal and bypass safety checks (for example the pre-flight/canDeleteServer validation).
    boolean
    removeInstances
    When true, also remove any instances associated with the host.
    boolean
    removeResources
    When true, also delete the backing cloud resources (the underlying VM/disks) rather than only removing the host record from Morpheus.
    boolean
    skipPolicyCheck
    When true, skip enforcement of removal policies for this host.
    Long
    userId
    Optional id of the user requesting the removal, recorded for auditing/attribution.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RemoveHostRequest()
     

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • force

      public boolean force
      When true, force the removal and bypass safety checks (for example the pre-flight/canDeleteServer validation). Use with care. Defaults to false.

    • removeResources

      public boolean removeResources
      When true, also delete the backing cloud resources (the underlying VM/disks) rather than only removing the host record from Morpheus. Defaults to false.

    • removeInstances

      public boolean removeInstances
      When true, also remove any instances associated with the host. Defaults to false.

    • userId

      public Long userId
      Optional id of the user requesting the removal, recorded for auditing/attribution. Passed by id as a reference to a persisted user; null attributes the action to the system.

    • skipPolicyCheck

      public boolean skipPolicyCheck
      When true, skip enforcement of removal policies for this host. Defaults to false.

  • Constructor Details

    • RemoveHostRequest

      public RemoveHostRequest()