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());
 

Author:

Adrian Cole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Fields

Modifier and Type	Field and Description
protected String	domainName
static SoftLayerTemplateOptions	NONE

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

blockUntilRunning, inboundPorts, privateKey, publicKey, script, tags, userMetadata

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

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

Constructor Summary

Constructors

Constructor and Description
SoftLayerTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
SoftLayerTemplateOptions	authorizePublicKey(String publicKey)
SoftLayerTemplateOptions	blockOnPort(int port, int seconds)
SoftLayerTemplateOptions	clone()
void	copyTo(org.jclouds.compute.options.TemplateOptions to)
org.jclouds.compute.options.TemplateOptions	domainName(String domainName) will replace the default domain used when ordering virtual guests.
String	getDomainName()
SoftLayerTemplateOptions	inboundPorts(int... ports)
SoftLayerTemplateOptions	installPrivateKey(String privateKey)
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, getInboundPorts, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, hashCode, nameTask, overrideAuthenticateSudo, overrideLoginCredentials, overrideLoginPassword, overrideLoginPrivateKey, overrideLoginUser, runAsRoot, runScript, runScript, 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

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:

VirtualGuestClient#orderVirtualGuest, InternetDomainName.hasPublicSuffix()

getDomainName

public String getDomainName()

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