Package jenkins.plugins.openstack.compute

Class JCloudsSlaveTemplate

java.lang.Object

jenkins.plugins.openstack.compute.JCloudsSlaveTemplate

All Implemented Interfaces:

Describable<JCloudsSlaveTemplate>, SlaveOptions.Holder

public class JCloudsSlaveTemplate
extends Object
implements Describable<JCloudsSlaveTemplate>, SlaveOptions.Holder

Author:

Vijay Kiran

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JCloudsSlaveTemplate.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPENSTACK_CLOUD_NAME_KEY
static final String	OPENSTACK_TEMPLATE_NAME_KEY

Constructor Summary

Constructors

Constructor	Description
JCloudsSlaveTemplate(String name, String labels, SlaveOptions slaveOptions)

Method Summary

Modifier and Type	Method	Description
boolean	canProvision(Label label)
Descriptor<JCloudsSlaveTemplate>	getDescriptor()
SlaveOptions	getEffectiveSlaveOptions()	Get effective options declared by this object.
String	getLabels()
Set<LabelAtom>	getLabelSet()
String	getName()
SlaveOptions	getRawSlaveOptions()	Get configured options held by this object.
org.openstack4j.model.compute.Server	provisionServer(ServerScope scope, org.jenkinsci.plugins.cloudstats.ProvisioningActivity.Id id)
JCloudsSlave	provisionSlave(JCloudsCloud cloud, org.jenkinsci.plugins.cloudstats.ProvisioningActivity.Id id)	Provision and connect as a slave.

Methods inherited from class java.lang.Object

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

Field Details

OPENSTACK_CLOUD_NAME_KEY

public static final String OPENSTACK_CLOUD_NAME_KEY

See Also:

• Constant Field Values

OPENSTACK_TEMPLATE_NAME_KEY

public static final String OPENSTACK_TEMPLATE_NAME_KEY

See Also:

• Constant Field Values

Constructor Details

JCloudsSlaveTemplate

@DataBoundConstructor
public JCloudsSlaveTemplate(@Nonnull
 String name,
 @Nonnull
 String labels,
 @CheckForNull
 SlaveOptions slaveOptions)

Method Details

getEffectiveSlaveOptions

@Nonnull
public SlaveOptions getEffectiveSlaveOptions()

Description copied from interface: SlaveOptions.Holder

Get effective options declared by this object. This is supposed to correctly evaluate all the overriding.

Specified by:

getEffectiveSlaveOptions in interface SlaveOptions.Holder

getRawSlaveOptions

@Nonnull
public SlaveOptions getRawSlaveOptions()

Description copied from interface: SlaveOptions.Holder

Get configured options held by this object. This holds only the user configured diffs compared to parent.

Specified by:

getRawSlaveOptions in interface SlaveOptions.Holder

getLabelSet

public Set<LabelAtom> getLabelSet()

getName

@Nonnull
public String getName()

getLabels

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Nonnull
public String getLabels()

canProvision

public boolean canProvision(Label label)

provisionSlave

@Nonnull
public JCloudsSlave provisionSlave(@Nonnull
 JCloudsCloud cloud,
 @Nonnull
 org.jenkinsci.plugins.cloudstats.ProvisioningActivity.Id id)
                            throws JCloudsCloud.ProvisioningFailedException

Provision and connect as a slave. The node is to be added to Jenkins by the caller. At the time the method completes, the node is ready to be launched.

Throws:

Openstack.ActionFailed - Provisioning failed.

JCloudsCloud.ProvisioningFailedException - Provisioning failed.

provisionServer

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Nonnull
public org.openstack4j.model.compute.Server provisionServer(@CheckForNull
 ServerScope scope,
 @CheckForNull
 org.jenkinsci.plugins.cloudstats.ProvisioningActivity.Id id)
                                                     throws Openstack.ActionFailed

Throws:

Openstack.ActionFailed

getDescriptor

public Descriptor<JCloudsSlaveTemplate> getDescriptor()

Specified by:

getDescriptor in interface Describable<JCloudsSlaveTemplate>