Package io.jenkins.plugins.swarmcloud

Class SwarmAgent

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Node

hudson.model.Slave

hudson.slaves.AbstractCloudSlave

io.jenkins.plugins.swarmcloud.SwarmAgent

All Implemented Interfaces:

ExtensionPoint, Describable<Node>, ModelObject, PersistenceRoot, ReconfigurableDescribable<Node>, Saveable, SearchableModelObject, SearchItem, AccessControlled, Serializable, OnMaster

public class SwarmAgent
extends AbstractCloudSlave

Jenkins agent running on Docker Swarm.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwarmAgent.DescriptorImpl
static class	SwarmAgent.SwarmComputer	Computer implementation for Swarm agents.

Nested classes/interfaces inherited from class hudson.model.Slave

Slave.JnlpJar, Slave.SlaveDescriptor

Nested classes/interfaces inherited from class hudson.model.Node

Node.Mode

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Slave

name, remoteFS

Fields inherited from class hudson.model.Node

holdOffLaunchUntilSave, SKIP_BUILD_CHECK_ON_FLYWEIGHTS

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
SwarmAgent(String name, SwarmAgentTemplate template, String cloudName, String serviceId)
SwarmAgent(String name, SwarmAgentTemplate template, String cloudName, String serviceId, int idleMinutes)	Constructor with custom idle timeout.

Method Summary

Modifier and Type	Method	Description
protected void	_terminate(TaskListener listener)
AbstractCloudComputer<?>	createComputer()
SwarmCloud	getCloud()	Gets the cloud that provisioned this agent.
String	getCloudName()
long	getCreatedTime()
String	getServiceId()
SwarmAgentTemplate	getTemplate()	Gets the template that was used to create this agent.
String	getTemplateName()
protected Object	readResolve()	Called after deserialization to restore transient state.

Methods inherited from class hudson.slaves.AbstractCloudSlave

terminate

Methods inherited from class hudson.model.Slave

createLauncher, drainLabelsToTrim, equals, getClockDifferenceCallable, getComputer, getDescriptor, getLabelAtomSet, getLabelString, getLauncher, getMode, getNodeDescription, getNodeName, getNodeProperties, getNumExecutors, getRemoteFS, getRetentionStrategy, getRootPath, getUserId, getWorkspaceFor, getWorkspaceRoot, hashCode, save, setLabelString, setLauncher, setMode, setNodeDescription, setNodeName, setNodeProperties, setNumExecutors, setRetentionStrategy, setUserId, toString

Methods inherited from class hudson.model.Node

canTake, canTake, createPath, getACL, getAssignedLabels, getChannel, getClockDifference, getConfigFile, getDisplayName, getFileSystemProvisioner, getLabelCloud, getNodeProperty, getNodeProperty, getNodePropertyDescriptors, getRootDir, getSearchUrl, getSelfLabel, getTemporaryOfflineCause, isAcceptingTasks, isHoldOffLaunchUntilSave, onLoad, reconfigure, reconfigure, toComputer

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Constructor Details

SwarmAgent

@DataBoundConstructor
public SwarmAgent(@NonNull
 String name,
 @NonNull
 SwarmAgentTemplate template,
 @NonNull
 String cloudName,
 @NonNull
 String serviceId)
           throws Descriptor.FormException,
IOException

Throws:

Descriptor.FormException

IOException

SwarmAgent

public SwarmAgent(@NonNull
 String name,
 @NonNull
 SwarmAgentTemplate template,
 @NonNull
 String cloudName,
 @NonNull
 String serviceId,
 int idleMinutes)
           throws Descriptor.FormException,
IOException

Constructor with custom idle timeout. Connection timeout is taken from the template configuration.

Throws:

Descriptor.FormException

IOException

Method Details

readResolve

protected Object readResolve()

Called after deserialization to restore transient state. Jenkins requires this to properly initialize the agent after loading from disk.

Overrides:

readResolve in class Slave

getCloudName

@NonNull
public String getCloudName()

getServiceId

@NonNull
public String getServiceId()

getTemplateName

@NonNull
public String getTemplateName()

getCreatedTime

public long getCreatedTime()

getCloud

@Nullable
public SwarmCloud getCloud()

Gets the cloud that provisioned this agent.

getTemplate

@Nullable
public SwarmAgentTemplate getTemplate()

Gets the template that was used to create this agent.

createComputer

public AbstractCloudComputer<?> createComputer()

Specified by:

createComputer in class AbstractCloudSlave

_terminate

protected void _terminate(TaskListener listener)
                   throws IOException,
InterruptedException

Specified by:

_terminate in class AbstractCloudSlave

Throws:

IOException

InterruptedException