org.jclouds.compute.options
Class RunScriptOptions.ImmutableRunScriptOptions

java.lang.Object
  org.jclouds.compute.options.RunScriptOptions
      org.jclouds.compute.options.RunScriptOptions.ImmutableRunScriptOptions

Enclosing class:

RunScriptOptions

public static class RunScriptOptions.ImmutableRunScriptOptions
extends RunScriptOptions

Nested Class Summary

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

RunScriptOptions.Builder, RunScriptOptions.ImmutableRunScriptOptions

Field Summary

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

blockOnComplete, NONE, overridingCredentials, port, runAsRoot, seconds, taskName, wrapInInitScript

Constructor Summary

RunScriptOptions.ImmutableRunScriptOptions(RunScriptOptions delegate)

Method Summary

RunScriptOptions	blockOnComplete(boolean blockOnComplete)
RunScriptOptions	blockOnPort(int port, int seconds) When the node is started, wait until the following port is active
Credentials	getOverrideCredentials() Whether to override the credentials with ones supplied in call to org.jclouds.compute.ComputeService#runScriptOnNodesWithTag.
int	getPort()
int	getSeconds()
String	getTaskName()
RunScriptOptions	nameTask(String name)
RunScriptOptions	runAsRoot(boolean runAsRoot)
boolean	shouldBlockOnComplete() Whether to wait until the script has completed.
boolean	shouldRunAsRoot() Whether to run the script as root (or run with current privileges).
String	toString()
RunScriptOptions	withOverridingCredentials(Credentials overridingCredentials)

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

shouldWrapInInitScript, wrapInInitScript

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RunScriptOptions.ImmutableRunScriptOptions

public RunScriptOptions.ImmutableRunScriptOptions(RunScriptOptions delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class RunScriptOptions

getOverrideCredentials

public Credentials getOverrideCredentials()

Description copied from class: RunScriptOptions

Whether to override the credentials with ones supplied in call to org.jclouds.compute.ComputeService#runScriptOnNodesWithTag. By default, true.

Overrides:

getOverrideCredentials in class RunScriptOptions

Returns:

value

shouldRunAsRoot

public boolean shouldRunAsRoot()

Description copied from class: RunScriptOptions

Whether to run the script as root (or run with current privileges). By default, true.

Overrides:

shouldRunAsRoot in class RunScriptOptions

Returns:

value

runAsRoot

public RunScriptOptions runAsRoot(boolean runAsRoot)

Overrides:

runAsRoot in class RunScriptOptions

shouldBlockOnComplete

public boolean shouldBlockOnComplete()

Description copied from class: RunScriptOptions

Whether to wait until the script has completed. By default, true.

Overrides:

shouldBlockOnComplete in class RunScriptOptions

Returns:

value

blockOnComplete

public RunScriptOptions blockOnComplete(boolean blockOnComplete)

Overrides:

blockOnComplete in class RunScriptOptions

withOverridingCredentials

public RunScriptOptions withOverridingCredentials(Credentials overridingCredentials)

Overrides:

withOverridingCredentials in class RunScriptOptions

getTaskName

public String getTaskName()

Overrides:

getTaskName in class RunScriptOptions

nameTask

public RunScriptOptions nameTask(String name)

Overrides:

nameTask in class RunScriptOptions

Returns:

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

blockOnPort

public RunScriptOptions blockOnPort(int port,
                                    int seconds)

Description copied from class: RunScriptOptions

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

Overrides:

blockOnPort in class RunScriptOptions

getPort

public int getPort()

Overrides:

getPort in class RunScriptOptions

getSeconds

public int getSeconds()

Overrides:

getSeconds in class RunScriptOptions