org.jclouds.docker.compute.options

Class DockerTemplateOptions

java.lang.Object

org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.TemplateOptions

org.jclouds.docker.compute.options.DockerTemplateOptions

All Implemented Interfaces:

Cloneable

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

Contains options supported in the ComputeService#runNode operation on the "docker" provider.

Usage

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

import static org.jclouds.docker.compute.options.DockerTemplateOptions.Builder.*;

ComputeService api = // get connection templateBuilder.options(inboundPorts(22, 80, 8080, 443)); Set set = api.createNodesInGroup(tag, 2, templateBuilder.build());

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerTemplateOptions.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 com.google.common.base.Optional<List<String>>	commands
protected com.google.common.base.Optional<Integer>	cpuShares
protected com.google.common.base.Optional<String>	dns
protected com.google.common.base.Optional<List<String>>	env
protected com.google.common.base.Optional<String>	hostname
protected com.google.common.base.Optional<Integer>	memory
static DockerTemplateOptions	NONE
protected com.google.common.base.Optional<Map<Integer,Integer>>	portBindings
protected com.google.common.base.Optional<Map<String,String>>	volumes

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

Constructors

Constructor and Description
DockerTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
DockerTemplateOptions	authorizePublicKey(String publicKey)
DockerTemplateOptions	blockOnPort(int port, int seconds)
DockerTemplateOptions	blockUntilRunning(boolean blockUntilRunning)
DockerTemplateOptions	clone()
DockerTemplateOptions	commands(Iterable<String> commands)
DockerTemplateOptions	commands(String... commands)
void	copyTo(org.jclouds.compute.options.TemplateOptions to)
DockerTemplateOptions	cpuShares(Integer cpuShares)
DockerTemplateOptions	dns(String dns)
DockerTemplateOptions	dontAuthorizePublicKey()
DockerTemplateOptions	env(Iterable<String> env)
DockerTemplateOptions	env(String... env)
boolean	equals(Object o)
com.google.common.base.Optional<List<String>>	getCommands()
com.google.common.base.Optional<Integer>	getCpuShares()
com.google.common.base.Optional<String>	getDns()
com.google.common.base.Optional<List<String>>	getEnv()
com.google.common.base.Optional<String>	getHostname()
com.google.common.base.Optional<Integer>	getMemory()
com.google.common.base.Optional<Map<Integer,Integer>>	getPortBindings()
com.google.common.base.Optional<Map<String,String>>	getVolumes()
int	hashCode()
DockerTemplateOptions	hostname(String hostname)
DockerTemplateOptions	inboundPorts(int... ports)
DockerTemplateOptions	installPrivateKey(String privateKey)
DockerTemplateOptions	memory(Integer memory)
DockerTemplateOptions	nameTask(String name)
DockerTemplateOptions	networks(Iterable<String> networks)
DockerTemplateOptions	nodeNames(Iterable<String> nodeNames)
DockerTemplateOptions	overrideAuthenticateSudo(boolean authenticateSudo)
DockerTemplateOptions	overrideLoginCredentials(org.jclouds.domain.LoginCredentials overridingCredentials)
DockerTemplateOptions	overrideLoginPassword(String password)
DockerTemplateOptions	overrideLoginPrivateKey(String privateKey)
DockerTemplateOptions	overrideLoginUser(String loginUser)
DockerTemplateOptions	portBindings(Map<Integer,Integer> portBindings) Set port bindings between the Docker host and a container.
DockerTemplateOptions	runAsRoot(boolean runAsRoot)
DockerTemplateOptions	runScript(org.jclouds.scriptbuilder.domain.Statement script)
String	toString()
DockerTemplateOptions	userMetadata(Map<String,String> userMetadata)
DockerTemplateOptions	userMetadata(String key, String value)
DockerTemplateOptions	volumes(Map<String,String> volumes)

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

getLoginPassword, getLoginPrivateKey, getLoginUser, 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

dns

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

hostname

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

memory

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

cpuShares

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

commands

protected com.google.common.base.Optional<List<String>> commands

volumes

protected com.google.common.base.Optional<Map<String,String>> volumes

env

protected com.google.common.base.Optional<List<String>> env

portBindings

protected com.google.common.base.Optional<Map<Integer,Integer>> portBindings

NONE

public static final DockerTemplateOptions NONE

Constructor Detail

DockerTemplateOptions

public DockerTemplateOptions()

Method Detail

clone

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

volumes

public DockerTemplateOptions volumes(Map<String,String> volumes)

dns

public DockerTemplateOptions dns(@Nullable
                        String dns)

hostname

public DockerTemplateOptions hostname(@Nullable
                             String hostname)

memory

public DockerTemplateOptions memory(@Nullable
                           Integer memory)

commands

public DockerTemplateOptions commands(Iterable<String> commands)

commands

public DockerTemplateOptions commands(String... commands)

cpuShares

public DockerTemplateOptions cpuShares(@Nullable
                              Integer cpuShares)

env

public DockerTemplateOptions env(Iterable<String> env)

env

public DockerTemplateOptions env(String... env)

portBindings

public DockerTemplateOptions portBindings(Map<Integer,Integer> portBindings)

Set port bindings between the Docker host and a container.

The Map keys are host ports number, and the value for an entry is the container port number. This is the same order as the arguments for the --publish command-line option to docker run which is hostPort:containerPort.

Parameters:

portBindings - the map of host to container port bindings

getVolumes

public com.google.common.base.Optional<Map<String,String>> getVolumes()

getDns

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

getHostname

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

getMemory

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

getCommands

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

getCpuShares

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

getEnv

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

getPortBindings

public com.google.common.base.Optional<Map<Integer,Integer>> getPortBindings()

blockOnPort

public DockerTemplateOptions blockOnPort(int port,
                                int seconds)

Overrides:

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

inboundPorts

public DockerTemplateOptions inboundPorts(int... ports)

Overrides:

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

authorizePublicKey

public DockerTemplateOptions authorizePublicKey(String publicKey)

Overrides:

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

installPrivateKey

public DockerTemplateOptions installPrivateKey(String privateKey)

Overrides:

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

blockUntilRunning

public DockerTemplateOptions blockUntilRunning(boolean blockUntilRunning)

Overrides:

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

dontAuthorizePublicKey

public DockerTemplateOptions dontAuthorizePublicKey()

Overrides:

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

nameTask

public DockerTemplateOptions nameTask(String name)

Overrides:

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

runAsRoot

public DockerTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

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

runScript

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

Overrides:

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

overrideLoginCredentials

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

Overrides:

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

overrideLoginPassword

public DockerTemplateOptions overrideLoginPassword(String password)

Overrides:

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

overrideLoginPrivateKey

public DockerTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:

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

overrideLoginUser

public DockerTemplateOptions overrideLoginUser(String loginUser)

Overrides:

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

overrideAuthenticateSudo

public DockerTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:

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

userMetadata

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

Overrides:

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

userMetadata

public DockerTemplateOptions userMetadata(String key,
                                 String value)

Overrides:

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

nodeNames

public DockerTemplateOptions nodeNames(Iterable<String> nodeNames)

Overrides:

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

networks

public DockerTemplateOptions networks(Iterable<String> networks)

Overrides:

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