Package jenkins.plugins.openstack.compute

Class SlaveOptions

java.lang.Object

jenkins.plugins.openstack.compute.SlaveOptions

All Implemented Interfaces:

Describable<SlaveOptions>, Serializable

public class SlaveOptions
extends Object
implements Describable<SlaveOptions>, Serializable

Configured options for a slave to create. This object can be scoped to cloud or template (or perhaps some other things). Whenever details are needed to provision/connect particular slave, the most specific SlaveOptions object should be used.

Author:

ogondza.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SlaveOptions.Builder
static interface	SlaveOptions.Holder	Interface to be implemented by configurable entity that contains options for provisioned slave.

Constructor Summary

Constructors

Constructor	Description
SlaveOptions(SlaveOptions.Builder b)
SlaveOptions(BootSource bootSource, String hardwareId, String networkId, String userDataId, Integer instanceCap, Integer instancesMin, String floatingIpPool, String securityGroups, String availabilityZone, Integer startTimeout, String keyPairName, Integer numExecutors, String jvmOptions, String fsRoot, LauncherFactory launcherFactory, List<? extends NodeProperty<?>> nodeProperties, Integer retentionTime, Boolean configDrive)

Method Summary

Modifier and Type	Method	Description
static SlaveOptions.Builder	builder()	Get empty builder.
static SlaveOptions	empty()
boolean	equals(Object o)
SlaveOptions	eraseDefaults(SlaveOptions defaults)	Derive new options from current leaving null where same as default.
String	getAvailabilityZone()
BootSource	getBootSource()
SlaveOptions.Builder	getBuilder()	Get builder to create modified version of current instance.
Boolean	getConfigDrive()
SlaveOptionsDescriptor	getDescriptor()
String	getFloatingIpPool()
String	getFsRoot()
String	getHardwareId()
Integer	getInstanceCap()
Integer	getInstancesMin()
String	getJvmOptions()
String	getKeyPairName()
LauncherFactory	getLauncherFactory()
String	getNetworkId()
List<NodeProperty<?>>	getNodeProperties()
Integer	getNumExecutors()
Integer	getRetentionTime()
String	getSecurityGroups()
Integer	getStartTimeout()
String	getUserDataId()
int	hashCode()
SlaveOptions	override(SlaveOptions o)	Derive SlaveOptions taking this instance as baseline and overriding with argument.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SlaveOptions

public SlaveOptions(SlaveOptions.Builder b)

SlaveOptions

@DataBoundConstructor
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public SlaveOptions(@CheckForNull
 BootSource bootSource,
 String hardwareId,
 String networkId,
 String userDataId,
 Integer instanceCap,
 Integer instancesMin,
 String floatingIpPool,
 String securityGroups,
 String availabilityZone,
 Integer startTimeout,
 String keyPairName,
 Integer numExecutors,
 String jvmOptions,
 String fsRoot,
 LauncherFactory launcherFactory,
 @CheckForNull
 List<? extends NodeProperty<?>> nodeProperties,
 Integer retentionTime,
 @CheckForNull
 Boolean configDrive)

Method Details

getFsRoot

@CheckForNull
public String getFsRoot()

getBootSource

@CheckForNull
public BootSource getBootSource()

getHardwareId

@CheckForNull
public String getHardwareId()

getNetworkId

@CheckForNull
public String getNetworkId()

getUserDataId

@CheckForNull
public String getUserDataId()

getInstanceCap

public Integer getInstanceCap()

getInstancesMin

public Integer getInstancesMin()

getFloatingIpPool

@CheckForNull
public String getFloatingIpPool()

getSecurityGroups

public String getSecurityGroups()

getAvailabilityZone

@CheckForNull
public String getAvailabilityZone()

getStartTimeout

public Integer getStartTimeout()

getKeyPairName

@CheckForNull
public String getKeyPairName()

getNumExecutors

public Integer getNumExecutors()

getJvmOptions

@CheckForNull
public String getJvmOptions()

getLauncherFactory

public LauncherFactory getLauncherFactory()

getNodeProperties

@CheckForNull
public List<NodeProperty<?>> getNodeProperties()

getRetentionTime

public Integer getRetentionTime()

getConfigDrive

@CheckForNull
public Boolean getConfigDrive()

override

@Nonnull
public SlaveOptions override(@Nonnull
 SlaveOptions o)

Derive SlaveOptions taking this instance as baseline and overriding with argument.

eraseDefaults

@Nonnull
public SlaveOptions eraseDefaults(@Nonnull
 SlaveOptions defaults)

Derive new options from current leaving null where same as default.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getBuilder

public SlaveOptions.Builder getBuilder()

Get builder to create modified version of current instance.

empty

@Nonnull
public static SlaveOptions empty()

builder

@Nonnull
public static SlaveOptions.Builder builder()

Get empty builder.

getDescriptor

public SlaveOptionsDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<SlaveOptions>