Package jenkins.agents

Class CloudSet

java.lang.Object
hudson.model.AbstractModelObject
jenkins.agents.CloudSet
All Implemented Interfaces:
ExtensionPoint, Action, Describable<CloudSet>, ModelObject, RootAction, SearchableModelObject, SearchItem, ModelObjectWithChildren, org.kohsuke.stapler.StaplerProxy
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public class CloudSet extends AbstractModelObject implements Describable<CloudSet>, ModelObjectWithChildren, RootAction, org.kohsuke.stapler.StaplerProxy

  • Constructor Details

    • CloudSet

      public CloudSet()

  • Method Details

    • getDescriptor

      public Descriptor<CloudSet> getDescriptor()
      Description copied from interface: Describable
      Gets the descriptor for this instance.

      Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

      Specified by:
      getDescriptor in interface Describable<CloudSet>

    • getDynamic

      public Cloud getDynamic(String token)

    • getTarget

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public Object getTarget()
      Specified by:
      getTarget in interface org.kohsuke.stapler.StaplerProxy

    • getIconFileName

      public String getIconFileName()
      Description copied from interface: Action
      Gets the name of the icon.
      Specified by:
      getIconFileName in interface Action
      Returns:
      If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

      If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

      If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

      Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

      See Also:

    • getDisplayName

      public String getDisplayName()
      Description copied from interface: Action
      Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject
      Returns:
      Can be null in case the action is hidden.

    • getUrlName

      public String getUrlName()
      Description copied from interface: Action
      Gets the URL path name.

      For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

      This method should return a string that's unique among other Actions.

      The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

      If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

      Specified by:
      getUrlName in interface Action
      Returns:
      null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().
      See Also:

    • getSearchUrl

      public String getSearchUrl()
      Description copied from interface: SearchItem
      Returns the URL of this item relative to the parent SearchItem.
      Specified by:
      getSearchUrl in interface SearchItem
      Returns:
      URL like "foo" or "foo/bar". The path can end with '/'. The path that starts with '/' will be interpreted as the absolute path (within the context path of Jenkins.)

    • getCloudUrl

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public String getCloudUrl(org.kohsuke.stapler.StaplerRequest2 request, Jenkins jenkins, Cloud cloud)

    • getCloudUrl

      @Deprecated @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public String getCloudUrl(org.kohsuke.stapler.StaplerRequest request, Jenkins jenkins, Cloud cloud)
      Deprecated.
      use getCloudUrl(StaplerRequest2, Jenkins, Cloud)

    • getCloudByIndex

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public Cloud getCloudByIndex(int index)

    • isCloudAvailable

      public boolean isCloudAvailable()

    • getCloudUpdateCenterCategoryLabel

      public String getCloudUpdateCenterCategoryLabel()

    • doChildrenContextMenu

      public ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response) throws Exception
      Description copied from interface: ModelObjectWithChildren
      Generates the context menu to list up all the children.
      Specified by:
      doChildrenContextMenu in interface ModelObjectWithChildren
      Throws:
      Exception

    • getDynamic

      public Cloud getDynamic(String name, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, jakarta.servlet.ServletException
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getClouds

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public Jenkins.CloudList getClouds()

    • hasClouds

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public boolean hasClouds()

    • checkName

      public String checkName(String name) throws Failure
      Makes sure that the given name is good as an agent name.
      Returns:
      trimmed name if valid; throws ParseException if not
      Throws:
      Failure

    • doCheckName

      public FormValidation doCheckName(@QueryParameter String value)

    • doCreate

      public void doCreate(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, @QueryParameter String name, @QueryParameter String mode, @QueryParameter String from) throws IOException, jakarta.servlet.ServletException, Descriptor.FormException
      First check point in creating a new cloud.
      Throws:
      IOException
      jakarta.servlet.ServletException
      Descriptor.FormException

    • doDoCreate

      @POST public void doDoCreate(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, @QueryParameter String cloudDescriptorName) throws IOException, jakarta.servlet.ServletException, Descriptor.FormException
      Really creates a new agent.
      Throws:
      IOException
      jakarta.servlet.ServletException
      Descriptor.FormException

    • doReorder

      @POST public void doReorder(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException
      Throws:
      IOException