org.jclouds.cloudsigma.compute.options

Class CloudSigmaTemplateOptions

java.lang.Object

org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.TemplateOptions

org.jclouds.cloudsigma.compute.options.CloudSigmaTemplateOptions

All Implemented Interfaces:

Cloneable

public class CloudSigmaTemplateOptions
extends TemplateOptions
implements Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudSigmaTemplateOptions.Builder

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

TemplateOptions.ImmutableTemplateOptions

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

RunScriptOptions.ImmutableRunScriptOptions

Field Summary

Fields

Modifier and Type	Field and Description
static CloudSigmaTemplateOptions	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
CloudSigmaTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
CloudSigmaTemplateOptions	authorizePublicKey(String publicKey) authorize an rsa ssh key.
CloudSigmaTemplateOptions	blockOnPort(int port, int seconds) When the node is started, wait until the following port is active
CloudSigmaTemplateOptions	blockUntilRunning(boolean blockUntilRunning) Note
CloudSigmaTemplateOptions	clone()
void	copyTo(TemplateOptions to)
CloudSigmaTemplateOptions	diskDriveAffinity(AffinityType diskDriveAffinity)
CloudSigmaTemplateOptions	dontAuthorizePublicKey()
boolean	equals(Object o)
AffinityType	getDiskDriveAffinity()
int	hashCode()
CloudSigmaTemplateOptions	inboundPorts(int... ports) Opens the set of ports to public access.
CloudSigmaTemplateOptions	installPrivateKey(String privateKey) replaces the rsa ssh key used at login.
CloudSigmaTemplateOptions	nameTask(String name)
CloudSigmaTemplateOptions	overrideAuthenticateSudo(boolean authenticateSudo)
CloudSigmaTemplateOptions	overrideCredentialsWith(Credentials overridingCredentials) Deprecated.
CloudSigmaTemplateOptions	overrideLoginCredentials(LoginCredentials overridingCredentials)
CloudSigmaTemplateOptions	overrideLoginCredentialWith(String loginCredential) Deprecated.
CloudSigmaTemplateOptions	overrideLoginPassword(String password)
CloudSigmaTemplateOptions	overrideLoginPrivateKey(String privateKey)
CloudSigmaTemplateOptions	overrideLoginUser(String loginUser)
CloudSigmaTemplateOptions	overrideLoginUserWith(String loginUser) Deprecated.
CloudSigmaTemplateOptions	runAsRoot(boolean runAsRoot)
CloudSigmaTemplateOptions	runScript(Payload script) Deprecated.
CloudSigmaTemplateOptions	runScript(Statement script) This script will be executed as the root user upon system startup.
String	toString()
CloudSigmaTemplateOptions	userMetadata(Map<String,String> userMetadata)
CloudSigmaTemplateOptions	userMetadata(String key, String value)

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

as, blockOnComplete, getInboundPorts, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, runScript, shouldBlockUntilRunning, tags, wrapInInitScript

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final CloudSigmaTemplateOptions NONE

Constructor Detail

CloudSigmaTemplateOptions

public CloudSigmaTemplateOptions()

Method Detail

diskDriveAffinity

public CloudSigmaTemplateOptions diskDriveAffinity(AffinityType diskDriveAffinity)

getDiskDriveAffinity

public AffinityType getDiskDriveAffinity()

clone

public CloudSigmaTemplateOptions clone()

Overrides:

clone in class TemplateOptions

copyTo

public void copyTo(TemplateOptions to)

Overrides:

copyTo in class TemplateOptions

blockOnPort

public CloudSigmaTemplateOptions blockOnPort(int port,
                                    int seconds)

When the node is started, wait until the following port is active

Overrides:

blockOnPort in class TemplateOptions

inboundPorts

public CloudSigmaTemplateOptions inboundPorts(int... ports)

Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

authorizePublicKey

public CloudSigmaTemplateOptions authorizePublicKey(String publicKey)

authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

installPrivateKey

public CloudSigmaTemplateOptions installPrivateKey(String privateKey)

replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

runScript

@Deprecated
public CloudSigmaTemplateOptions runScript(Payload script)

Deprecated.

to be removed in jclouds 1.4.0

Overrides:

runScript in class TemplateOptions

See Also:

TemplateOptions.ImmutableTemplateOptions.runScript(Statement), Payloads

blockUntilRunning

public CloudSigmaTemplateOptions blockUntilRunning(boolean blockUntilRunning)

Note

As of version 1.1.0, this option is incompatible with TemplateOptions.ImmutableTemplateOptions.runScript(Statement) and RunScriptOptions.blockOnComplete(boolean), as all current implementations utilize ssh in order to execute scripts.

Overrides:

blockUntilRunning in class TemplateOptions

Parameters:

blockUntilRunning - (default true) whether to block until the nodes in this template are in NodeState.RUNNING state

dontAuthorizePublicKey

public CloudSigmaTemplateOptions dontAuthorizePublicKey()

Overrides:

dontAuthorizePublicKey in class TemplateOptions

nameTask

public CloudSigmaTemplateOptions nameTask(String name)

Overrides:

nameTask in class TemplateOptions

Returns:

What to call the task relating to this script; default jclouds-script-timestamp where timestamp is millis since epoch

runAsRoot

public CloudSigmaTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

runAsRoot in class TemplateOptions

runScript

public CloudSigmaTemplateOptions runScript(Statement script)

This script will be executed as the root user upon system startup. This script gets a prologue, so no #!/bin/bash required, path set up, etc

Overrides:

runScript in class TemplateOptions

overrideCredentialsWith

@Deprecated
public CloudSigmaTemplateOptions overrideCredentialsWith(Credentials overridingCredentials)

Deprecated.

to be removed in jclouds 1.4.0

Overrides:

overrideCredentialsWith in class TemplateOptions

See Also:

RunScriptOptions.overrideLoginCredentials(org.jclouds.domain.LoginCredentials)

overrideLoginUserWith

@Deprecated
public CloudSigmaTemplateOptions overrideLoginUserWith(String loginUser)

Deprecated.

to be removed in jclouds 1.4.0

Overrides:

overrideLoginUserWith in class TemplateOptions

See Also:

RunScriptOptions.overrideLoginCredentials(org.jclouds.domain.LoginCredentials)

overrideLoginCredentialWith

@Deprecated
public CloudSigmaTemplateOptions overrideLoginCredentialWith(String loginCredential)

Deprecated.

to be removed in jclouds 1.4.0

Overrides:

overrideLoginCredentialWith in class TemplateOptions

See Also:

RunScriptOptions.overrideLoginCredentials(org.jclouds.domain.LoginCredentials)

overrideLoginCredentials

public CloudSigmaTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)

Overrides:

overrideLoginCredentials in class TemplateOptions

overrideLoginPassword

public CloudSigmaTemplateOptions overrideLoginPassword(String password)

Overrides:

overrideLoginPassword in class TemplateOptions

overrideLoginPrivateKey

public CloudSigmaTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:

overrideLoginPrivateKey in class TemplateOptions

overrideLoginUser

public CloudSigmaTemplateOptions overrideLoginUser(String loginUser)

Overrides:

overrideLoginUser in class TemplateOptions

overrideAuthenticateSudo

public CloudSigmaTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:

overrideAuthenticateSudo in class TemplateOptions

userMetadata

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

Overrides:

userMetadata in class TemplateOptions

Parameters:

userMetadata - user-defined metadata to assign to this server

userMetadata

public CloudSigmaTemplateOptions userMetadata(String key,
                                     String value)

Overrides:

userMetadata in class TemplateOptions

Parameters:

key - key to place into the metadata map

value - value to associate with that key

equals

public boolean equals(Object o)

Overrides:

equals in class TemplateOptions

hashCode

public int hashCode()

Overrides:

hashCode in class TemplateOptions

toString

public String toString()

Overrides:

toString in class TemplateOptions