org.jclouds.softlayer.compute.options
Class SoftLayerTemplateOptions

java.lang.Object
  org.jclouds.compute.options.RunScriptOptions
      org.jclouds.compute.options.TemplateOptions
          org.jclouds.softlayer.compute.options.SoftLayerTemplateOptions

All Implemented Interfaces:

Cloneable

public class SoftLayerTemplateOptions
extends org.jclouds.compute.options.TemplateOptions
implements Cloneable

Contains options supported by the ComputeService.createNodesInGroup(String, int, TemplateOptions) and ComputeService.createNodesInGroup(String, int, TemplateOptions) operations on the gogrid provider.

Usage

The recommended way to instantiate a SoftLayerTemplateOptions object is to statically import SoftLayerTemplateOptions.* and invoke a static creation method followed by an instance mutator (if needed):

 import static org.jclouds.compute.options.SoftLayerTemplateOptions.Builder.*;
 ComputeService client = // get connection
 templateBuilder.options(inboundPorts(22, 80, 8080, 443));
 Set<? extends NodeMetadata> set = client.createNodesInGroup(tag, 2, templateBuilder.build());
 

Nested Class Summary

static class

SoftLayerTemplateOptions.Builder

Nested classes/interfaces inherited from class org.jclouds.compute.options.TemplateOptions

org.jclouds.compute.options.TemplateOptions.ImmutableTemplateOptions

Nested classes/interfaces inherited from class org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.RunScriptOptions.ImmutableRunScriptOptions

Field Summary

protected com.google.common.base.Optional<List<Integer>>	blockDevices
protected com.google.common.base.Optional<String>	diskType
protected String	domainName
static SoftLayerTemplateOptions	NONE
protected com.google.common.base.Optional<Integer>	portSpeed

Fields inherited from class org.jclouds.compute.options.TemplateOptions

blockUntilRunning, inboundPorts, networks, nodeNames, privateKey, publicKey, script, securityGroups, tags, userMetadata

Fields inherited from class org.jclouds.compute.options.RunScriptOptions

authenticateSudo, blockOnComplete, loginPassword, loginPrivateKey, loginUser, port, runAsRoot, seconds, taskName, wrapInInitScript

Constructor Summary

SoftLayerTemplateOptions()

Method Summary

SoftLayerTemplateOptions	authorizePublicKey(String publicKey)
org.jclouds.compute.options.TemplateOptions	blockDevices(Integer... capacities)
org.jclouds.compute.options.TemplateOptions	blockDevices(Iterable<Integer> capacities)
SoftLayerTemplateOptions	blockOnPort(int port, int seconds)
SoftLayerTemplateOptions	clone()
void	copyTo(org.jclouds.compute.options.TemplateOptions to)
org.jclouds.compute.options.TemplateOptions	diskType(String diskType)
org.jclouds.compute.options.TemplateOptions	domainName(String domainName) will replace the default domain used when ordering virtual guests.
com.google.common.base.Optional<List<Integer>>	getBlockDevices()
com.google.common.base.Optional<String>	getDiskType()
String	getDomainName()
com.google.common.base.Optional<Integer>	getPortSpeed()
SoftLayerTemplateOptions	inboundPorts(int... ports)
SoftLayerTemplateOptions	installPrivateKey(String privateKey)
SoftLayerTemplateOptions	networks(Iterable<String> networks)
SoftLayerTemplateOptions	nodeNames(Iterable<String> nodeNames)
org.jclouds.compute.options.TemplateOptions	portSpeed(Integer portSpeed)
SoftLayerTemplateOptions	userMetadata(Map<String,String> userMetadata)
SoftLayerTemplateOptions	userMetadata(String key, String value)

Methods inherited from class org.jclouds.compute.options.TemplateOptions

as, blockOnComplete, blockUntilRunning, dontAuthorizePublicKey, equals, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, hashCode, nameTask, networks, overrideAuthenticateSudo, overrideLoginCredentials, overrideLoginPassword, overrideLoginPrivateKey, overrideLoginUser, runAsRoot, runScript, runScript, securityGroups, securityGroups, shouldBlockUntilRunning, string, tags, wrapInInitScript

Methods inherited from class org.jclouds.compute.options.RunScriptOptions

getLoginPassword, getLoginPrivateKey, getLoginUser, getPort, getSeconds, getTaskName, hasLoginPassword, hasLoginPasswordOption, hasLoginPrivateKey, hasLoginPrivateKeyOption, shouldAuthenticateSudo, shouldBlockOnComplete, shouldRunAsRoot, shouldWrapInInitScript, toString

Methods inherited from class java.lang.Object

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

Field Detail

domainName

protected String domainName

blockDevices

protected com.google.common.base.Optional<List<Integer>> blockDevices

diskType

protected com.google.common.base.Optional<String> diskType

portSpeed

protected com.google.common.base.Optional<Integer> portSpeed

NONE

public static final SoftLayerTemplateOptions NONE

Constructor Detail

SoftLayerTemplateOptions

public SoftLayerTemplateOptions()

Method Detail

clone

public SoftLayerTemplateOptions clone()

Overrides:

clone in class org.jclouds.compute.options.TemplateOptions

copyTo

public void copyTo(org.jclouds.compute.options.TemplateOptions to)

Overrides:

copyTo in class org.jclouds.compute.options.TemplateOptions

domainName

public org.jclouds.compute.options.TemplateOptions domainName(String domainName)

will replace the default domain used when ordering virtual guests. Note this needs to contain a public suffix!

See Also:

VirtualGuestApi.createVirtualGuest(org.jclouds.softlayer.domain.VirtualGuest), InternetDomainName.hasPublicSuffix()

blockDevices

public org.jclouds.compute.options.TemplateOptions blockDevices(Iterable<Integer> capacities)

blockDevices

public org.jclouds.compute.options.TemplateOptions blockDevices(Integer... capacities)

diskType

public org.jclouds.compute.options.TemplateOptions diskType(String diskType)

portSpeed

public org.jclouds.compute.options.TemplateOptions portSpeed(Integer portSpeed)

getDomainName

public String getDomainName()

getBlockDevices

public com.google.common.base.Optional<List<Integer>> getBlockDevices()

getDiskType

public com.google.common.base.Optional<String> getDiskType()

getPortSpeed

public com.google.common.base.Optional<Integer> getPortSpeed()

blockOnPort

public SoftLayerTemplateOptions blockOnPort(int port,
                                            int seconds)

Overrides:

blockOnPort in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.blockOnPort(int, int)

inboundPorts

public SoftLayerTemplateOptions inboundPorts(int... ports)

Overrides:

inboundPorts in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.inboundPorts(int...)

authorizePublicKey

public SoftLayerTemplateOptions authorizePublicKey(String publicKey)

Overrides:

authorizePublicKey in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.authorizePublicKey(String)

installPrivateKey

public SoftLayerTemplateOptions installPrivateKey(String privateKey)

Overrides:

installPrivateKey in class org.jclouds.compute.options.TemplateOptions

See Also:

TemplateOptions.installPrivateKey(String)

userMetadata

public SoftLayerTemplateOptions userMetadata(Map<String,String> userMetadata)

Overrides:

userMetadata in class org.jclouds.compute.options.TemplateOptions

userMetadata

public SoftLayerTemplateOptions userMetadata(String key,
                                             String value)

Overrides:

userMetadata in class org.jclouds.compute.options.TemplateOptions

nodeNames

public SoftLayerTemplateOptions nodeNames(Iterable<String> nodeNames)

Overrides:

nodeNames in class org.jclouds.compute.options.TemplateOptions

networks

public SoftLayerTemplateOptions networks(Iterable<String> networks)

Overrides:

networks in class org.jclouds.compute.options.TemplateOptions