org.jclouds.cloudstack.compute.options

Class CloudStackTemplateOptions

java.lang.Object

org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.TemplateOptions

org.jclouds.cloudstack.compute.options.CloudStackTemplateOptions

All Implemented Interfaces:

Cloneable

public class CloudStackTemplateOptions
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 CloudStackTemplateOptions object is to statically import CloudStackTemplateOptions.* and invoke a static creation method followed by an instance mutator (if needed):

 import static org.jclouds.compute.options.CloudStackTemplateOptions.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

Nested Classes

Modifier and Type	Class and Description
static class	CloudStackTemplateOptions.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 inherited from class org.jclouds.compute.options.TemplateOptions

blockUntilRunning, inboundPorts, networks, nodeNames, NONE, 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

Constructors

Constructor and Description
CloudStackTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
CloudStackTemplateOptions	account(String account)
CloudStackTemplateOptions	authorizePublicKey(String publicKey)
CloudStackTemplateOptions	blockOnPort(int port, int seconds)
CloudStackTemplateOptions	blockUntilRunning(boolean blockUntilRunning)
CloudStackTemplateOptions	clone()
void	copyTo(org.jclouds.compute.options.TemplateOptions to)
CloudStackTemplateOptions	dataDiskSize(int dataDiskSize)
CloudStackTemplateOptions	diskOfferingId(String diskOfferingId)
CloudStackTemplateOptions	domainId(String domainId)
CloudStackTemplateOptions	dontAuthorizePublicKey()
boolean	equals(Object o)
CloudStackTemplateOptions	generateKeyPair(boolean generateKeyPair)
CloudStackTemplateOptions	generateSecurityGroup(boolean generateSecurityGroup)
String	getAccount()
int	getDataDiskSize()
String	getDiskOfferingId()
String	getDomainId()
String	getIpOnDefaultNetwork()
Map<String,String>	getIpsToNetworks()
String	getKeyPair()
Set<String>	getSecurityGroupIds()
byte[]	getUserData()
int	hashCode()
CloudStackTemplateOptions	inboundPorts(int... ports)
CloudStackTemplateOptions	installPrivateKey(String privateKey)
CloudStackTemplateOptions	ipOnDefaultNetwork(String ipOnDefaultNetwork)
CloudStackTemplateOptions	ipsToNetworks(Map<String,String> ipsToNetworks)
CloudStackTemplateOptions	keyPair(String keyPair)
CloudStackTemplateOptions	nameTask(String name)
CloudStackTemplateOptions	networks(Iterable<String> networks)
CloudStackTemplateOptions	nodeNames(Iterable<String> nodeNames)
CloudStackTemplateOptions	overrideAuthenticateSudo(boolean authenticateSudo)
CloudStackTemplateOptions	overrideLoginCredentials(org.jclouds.domain.LoginCredentials overridingCredentials)
CloudStackTemplateOptions	overrideLoginPassword(String password)
CloudStackTemplateOptions	overrideLoginPrivateKey(String privateKey)
CloudStackTemplateOptions	overrideLoginUser(String loginUser)
CloudStackTemplateOptions	runAsRoot(boolean runAsRoot)
CloudStackTemplateOptions	runScript(org.jclouds.scriptbuilder.domain.Statement script)
CloudStackTemplateOptions	securityGroupIds(Iterable<String> securityGroupIds)
CloudStackTemplateOptions	setupStaticNat(boolean setupStaticNat)
boolean	shouldGenerateKeyPair()
boolean	shouldGenerateSecurityGroup()
boolean	shouldSetupStaticNat()
String	toString()
CloudStackTemplateOptions	userData(byte[] userData)
CloudStackTemplateOptions	userData(String userData)
CloudStackTemplateOptions	userData(URL userDataUrl)
CloudStackTemplateOptions	userMetadata(Map<String,String> userMetadata)
CloudStackTemplateOptions	userMetadata(String key, String value)

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

as, blockOnComplete, getGroups, getInboundPorts, getNetworks, getNodeNames, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, networks, runScript, securityGroups, securityGroups, shouldBlockUntilRunning, string, tags, wrapInInitScript

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

copyTo, getLoginPassword, getLoginPrivateKey, getLoginUser, getPort, getSeconds, getTaskName, hasLoginPassword, hasLoginPasswordOption, hasLoginPrivateKey, hasLoginPrivateKeyOption, overrideLoginPassword, overrideLoginPrivateKey, shouldAuthenticateSudo, shouldBlockOnComplete, shouldRunAsRoot, shouldWrapInInitScript

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudStackTemplateOptions

public CloudStackTemplateOptions()

Method Detail

securityGroupIds

public CloudStackTemplateOptions securityGroupIds(Iterable<String> securityGroupIds)

ipsToNetworks

public CloudStackTemplateOptions ipsToNetworks(Map<String,String> ipsToNetworks)

ipOnDefaultNetwork

public CloudStackTemplateOptions ipOnDefaultNetwork(String ipOnDefaultNetwork)

keyPair

public CloudStackTemplateOptions keyPair(String keyPair)

setupStaticNat

public CloudStackTemplateOptions setupStaticNat(boolean setupStaticNat)

account

public CloudStackTemplateOptions account(String account)

domainId

public CloudStackTemplateOptions domainId(String domainId)

generateKeyPair

public CloudStackTemplateOptions generateKeyPair(boolean generateKeyPair)

generateSecurityGroup

public CloudStackTemplateOptions generateSecurityGroup(boolean generateSecurityGroup)

diskOfferingId

public CloudStackTemplateOptions diskOfferingId(String diskOfferingId)

dataDiskSize

public CloudStackTemplateOptions dataDiskSize(int dataDiskSize)

userData

public CloudStackTemplateOptions userData(byte[] userData)

userData

public CloudStackTemplateOptions userData(String userData)

userData

public CloudStackTemplateOptions userData(URL userDataUrl)
                                   throws IOException

Throws:

IOException

getSecurityGroupIds

public Set<String> getSecurityGroupIds()

getIpsToNetworks

public Map<String,String> getIpsToNetworks()

getIpOnDefaultNetwork

public String getIpOnDefaultNetwork()

getKeyPair

public String getKeyPair()

shouldSetupStaticNat

public boolean shouldSetupStaticNat()

getAccount

public String getAccount()

getDomainId

public String getDomainId()

shouldGenerateKeyPair

public boolean shouldGenerateKeyPair()

shouldGenerateSecurityGroup

public boolean shouldGenerateSecurityGroup()

getDiskOfferingId

public String getDiskOfferingId()

getDataDiskSize

public int getDataDiskSize()

getUserData

public byte[] getUserData()

clone

public CloudStackTemplateOptions 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

equals

public boolean equals(Object o)

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

toString

public String toString()

Overrides:

toString in class org.jclouds.compute.options.RunScriptOptions

blockOnPort

public CloudStackTemplateOptions blockOnPort(int port,
                                    int seconds)

Overrides:

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

inboundPorts

public CloudStackTemplateOptions inboundPorts(int... ports)

Overrides:

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

authorizePublicKey

public CloudStackTemplateOptions authorizePublicKey(String publicKey)

Overrides:

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

installPrivateKey

public CloudStackTemplateOptions installPrivateKey(String privateKey)

Overrides:

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

blockUntilRunning

public CloudStackTemplateOptions blockUntilRunning(boolean blockUntilRunning)

Overrides:

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

dontAuthorizePublicKey

public CloudStackTemplateOptions dontAuthorizePublicKey()

Overrides:

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

nameTask

public CloudStackTemplateOptions nameTask(String name)

Overrides:

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

runAsRoot

public CloudStackTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

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

runScript

public CloudStackTemplateOptions runScript(org.jclouds.scriptbuilder.domain.Statement script)

Overrides:

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

overrideLoginCredentials

public CloudStackTemplateOptions overrideLoginCredentials(org.jclouds.domain.LoginCredentials overridingCredentials)

Overrides:

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

overrideLoginPassword

public CloudStackTemplateOptions overrideLoginPassword(String password)

Overrides:

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

overrideLoginPrivateKey

public CloudStackTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:

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

overrideLoginUser

public CloudStackTemplateOptions overrideLoginUser(String loginUser)

Overrides:

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

overrideAuthenticateSudo

public CloudStackTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:

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

userMetadata

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

Overrides:

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

userMetadata

public CloudStackTemplateOptions userMetadata(String key,
                                     String value)

Overrides:

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

nodeNames

public CloudStackTemplateOptions nodeNames(Iterable<String> nodeNames)

Overrides:

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

networks

public CloudStackTemplateOptions networks(Iterable<String> networks)

Overrides:

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