org.jclouds.vcloud.compute.options
Class VCloudTemplateOptions

java.lang.Object
  extended by org.jclouds.compute.options.RunScriptOptions
      extended by org.jclouds.compute.options.TemplateOptions
          extended by org.jclouds.vcloud.compute.options.VCloudTemplateOptions
All Implemented Interfaces:
Cloneable

public class VCloudTemplateOptions
extends TemplateOptions
implements Cloneable

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

Usage

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

import static org.jclouds.compute.options.VCloudTemplateOptions.Builder.*;

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

Author:
Adrian Cole

Nested Class Summary
static class VCloudTemplateOptions.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
static VCloudTemplateOptions 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
VCloudTemplateOptions()
           
 
Method Summary
 VCloudTemplateOptions authorizePublicKey(String publicKey)
          authorize an rsa ssh key.
 VCloudTemplateOptions blockOnPort(int port, int seconds)
          When the node is started, wait until the following port is active
 VCloudTemplateOptions clone()
           
 void copyTo(TemplateOptions to)
           
 VCloudTemplateOptions customizationScript(String customizationScript)
          Specifies the customizationScript used to run instances with
 VCloudTemplateOptions description(String description)
          Optional description.
 boolean equals(Object obj)
           
 String getCustomizationScript()
           
 String getDescription()
           
 IpAddressAllocationMode getIpAddressAllocationMode()
           
 int hashCode()
           
 VCloudTemplateOptions inboundPorts(int... ports)
          special thing is that we do assume if you are passing groups that you have everything you need already defined.
 VCloudTemplateOptions installPrivateKey(String privateKey)
          replaces the rsa ssh key used at login.
 VCloudTemplateOptions ipAddressAllocationMode(IpAddressAllocationMode ipAddressAllocationMode)
          Specifies the ipAddressAllocationMode used to for network interfaces on the VMs
 VCloudTemplateOptions runScript(Payload script)
          Deprecated. 
 String toString()
           
 VCloudTemplateOptions userMetadata(Map<String,String> userMetadata)
          
 VCloudTemplateOptions userMetadata(String key, String value)
          
 
Methods inherited from class org.jclouds.compute.options.TemplateOptions
as, blockOnComplete, blockUntilRunning, dontAuthorizePublicKey, getInboundPorts, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, nameTask, overrideAuthenticateSudo, overrideCredentialsWith, overrideLoginCredentials, overrideLoginCredentialWith, overrideLoginPassword, overrideLoginPrivateKey, overrideLoginUser, overrideLoginUserWith, runAsRoot, runScript, 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 VCloudTemplateOptions NONE
Constructor Detail

VCloudTemplateOptions

public VCloudTemplateOptions()
Method Detail

clone

public VCloudTemplateOptions clone()
Overrides:
clone in class TemplateOptions

copyTo

public void copyTo(TemplateOptions to)
Overrides:
copyTo in class TemplateOptions

description

public VCloudTemplateOptions description(String description)
Optional description. Used for the Description of the vApp created by this instantiation.


customizationScript

public VCloudTemplateOptions customizationScript(String customizationScript)
Specifies the customizationScript used to run instances with


ipAddressAllocationMode

public VCloudTemplateOptions ipAddressAllocationMode(IpAddressAllocationMode ipAddressAllocationMode)
Specifies the ipAddressAllocationMode used to for network interfaces on the VMs


getDescription

public String getDescription()
Returns:
description of the vApp

getCustomizationScript

public String getCustomizationScript()
Returns:
customizationScript on the vms

getIpAddressAllocationMode

public IpAddressAllocationMode getIpAddressAllocationMode()
Returns:
ipAddressAllocationMode on the vms

blockOnPort

public VCloudTemplateOptions 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 TemplateOptions
See Also:
TemplateOptions.blockOnPort(int, int)

inboundPorts

public VCloudTemplateOptions inboundPorts(int... ports)
special thing is that we do assume if you are passing groups that you have everything you need already defined. for example, our option inboundPorts normally creates ingress rules accordingly but if we notice you've specified securityGroups, we do not mess with rules at all

Overrides:
inboundPorts in class TemplateOptions
See Also:
TemplateOptions.inboundPorts

authorizePublicKey

public VCloudTemplateOptions authorizePublicKey(String publicKey)
Description copied from class: TemplateOptions
authorize an rsa ssh key.

Overrides:
authorizePublicKey in class TemplateOptions
See Also:
TemplateOptions.authorizePublicKey(String)

installPrivateKey

public VCloudTemplateOptions installPrivateKey(String privateKey)
Description copied from class: TemplateOptions
replaces the rsa ssh key used at login.

Overrides:
installPrivateKey in class TemplateOptions
See Also:
TemplateOptions.installPrivateKey(String)

runScript

@Deprecated
public VCloudTemplateOptions runScript(Payload script)
Deprecated. 

Description copied from class: TemplateOptions
to be removed in jclouds 1.4.0

Overrides:
runScript in class TemplateOptions
See Also:
TemplateOptions.runScript(Payload)

userMetadata

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

Overrides:
userMetadata in class TemplateOptions
Parameters:
userMetadata - user-defined metadata to assign to this server

userMetadata

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

hashCode

public int hashCode()
Overrides:
hashCode in class TemplateOptions

equals

public boolean equals(Object obj)
Overrides:
equals in class TemplateOptions

toString

public String toString()
Overrides:
toString in class TemplateOptions


Copyright © 2009-2012 jclouds. All Rights Reserved.