Constructor Detail

• GoogleComputeEngineTemplateOptions

  public GoogleComputeEngineTemplateOptions()

Method Detail

• clone

  public GoogleComputeEngineTemplateOptions clone()

  Overrides:

  clone in class TemplateOptions

• copyTo

  public void copyTo(TemplateOptions to)

  Overrides:

  copyTo in class TemplateOptions

• bootDiskType

  public GoogleComputeEngineTemplateOptions bootDiskType(String diskType)

  Sets the boot disk type.

• bootDiskType

  public String bootDiskType()

  Gets the boot disk type.

• assignExternalIp

  public GoogleComputeEngineTemplateOptions assignExternalIp(boolean assignExternalIp)

  Sets whether an external IP address should be assigned to the machine.

• assignExternalIp

  public boolean assignExternalIp()

  Gets whether an external IP address should be assigned to the machine.

• autoCreateKeyPair

  public GoogleComputeEngineTemplateOptions autoCreateKeyPair(boolean autoCreateKeyPair)

  Sets whether an SSH key pair should be created automatically.

• autoCreateKeyPair

  public boolean autoCreateKeyPair()

  Gets whether an SSH key pair should be created automatically.

• serviceAccounts

  public GoogleComputeEngineTemplateOptions serviceAccounts(List<Instance.ServiceAccount> serviceAccounts)

  Sets a list of service accounts, with their specified scopes, to authorize on created instance. For example, to give a node the 'compute' scope you would add a service account with the email 'default' and the scope 'https://www.googleapis.com/auth/compute' These scopes will be given to all nodes created with these template options.

• preemptible

  public GoogleComputeEngineTemplateOptions preemptible(boolean preemptible)

  Sets whether the resulting instance should be preemptible.

• preemptible

  public boolean preemptible()

  Gets whether the resulting instance should be preemptible.

• autoCreateWindowsPassword

  public Boolean autoCreateWindowsPassword()

  Whether a Windows password should be created automatically; null means to generate the password if and only if the image is for a Windows VM.

• autoCreateWindowsPassword

  public GoogleComputeEngineTemplateOptions autoCreateWindowsPassword(Boolean autoCreateWindowsPassword)

  Sets whether to auto-create a windows password. The default (null) is to always do so for Windows VMs, inferring this from the image. An explicit value of true or false overrides this.

• serviceAccounts

  public List<Instance.ServiceAccount> serviceAccounts()

  Gets the list of service accounts, with their specified scopes, that will be authorize on created instances.

• blockOnPort

  public GoogleComputeEngineTemplateOptions blockOnPort(int port,
                                               int seconds)

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

  Overrides:

  blockOnPort in class TemplateOptions

• inboundPorts

  public GoogleComputeEngineTemplateOptions inboundPorts(int... ports)

  Opens the set of ports to public access.

  Overrides:

  inboundPorts in class TemplateOptions

• authorizePublicKey

  public GoogleComputeEngineTemplateOptions authorizePublicKey(String publicKey)

  authorize an rsa ssh key.

  Overrides:

  authorizePublicKey in class TemplateOptions

• installPrivateKey

  public GoogleComputeEngineTemplateOptions installPrivateKey(String privateKey)

  replaces the rsa ssh key used at login.

  Overrides:

  installPrivateKey in class TemplateOptions

• blockUntilRunning

  public GoogleComputeEngineTemplateOptions blockUntilRunning(boolean blockUntilRunning)

  Note

  As of version 1.1.0, this option is incompatible with TemplateOptions.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 Status#RUNNING state

• dontAuthorizePublicKey

  public GoogleComputeEngineTemplateOptions dontAuthorizePublicKey()

  Overrides:

  dontAuthorizePublicKey in class TemplateOptions

• nameTask

  public GoogleComputeEngineTemplateOptions 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 GoogleComputeEngineTemplateOptions runAsRoot(boolean runAsRoot)

  Overrides:

  runAsRoot in class TemplateOptions

• runScript

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

• overrideLoginCredentials

  public GoogleComputeEngineTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)

  Overrides:

  overrideLoginCredentials in class TemplateOptions

• overrideLoginPassword

  public GoogleComputeEngineTemplateOptions overrideLoginPassword(String password)

  Overrides:

  overrideLoginPassword in class TemplateOptions

• overrideLoginPrivateKey

  public GoogleComputeEngineTemplateOptions overrideLoginPrivateKey(String privateKey)

  Overrides:

  overrideLoginPrivateKey in class TemplateOptions

• overrideLoginUser

  public GoogleComputeEngineTemplateOptions overrideLoginUser(String loginUser)

  Overrides:

  overrideLoginUser in class TemplateOptions

• overrideAuthenticateSudo

  public GoogleComputeEngineTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

  Overrides:

  overrideAuthenticateSudo in class TemplateOptions

• userMetadata

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

  Overrides:

  userMetadata in class TemplateOptions

  Parameters:

  userMetadata - user-defined metadata to assign to this server

• userMetadata

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

• nodeNames

  public GoogleComputeEngineTemplateOptions nodeNames(Iterable<String> nodeNames)

  specifies names to be used for the created nodes. Note that this does not guarantee uniqueness - if there are already existing nodes with a name specified here, there will still be a new node created with the same name. Also, if more nodes are to be created than there are names, subsequent names will use the default naming strategy for that cloud.

  Overrides:

  nodeNames in class TemplateOptions

• networks

  public GoogleComputeEngineTemplateOptions networks(Iterable<String> networks)

  Assigns the created nodes to these networks

  Overrides:

  networks in class TemplateOptions

• networks

  public GoogleComputeEngineTemplateOptions networks(String... networks)

  Overrides:

  networks in class TemplateOptions

  See Also:

  TemplateOptions.networks(Iterable)

• tags

  public GoogleComputeEngineTemplateOptions tags(Iterable<String> tags)

  assigns tags to the created nodes

  Overrides:

  tags in class TemplateOptions

• wrapInInitScript

  public GoogleComputeEngineTemplateOptions wrapInInitScript(boolean wrapInInitScript)

  default true

  Overrides:

  wrapInInitScript in class TemplateOptions

  Parameters:

  wrapInInitScript - if the command is long-running, use this option to ensure it is wrapInInitScripted properly. (ex. have jclouds wrap it an init script, nohup, etc)

  Returns:

• runScript

  public GoogleComputeEngineTemplateOptions runScript(String 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

• blockOnComplete

  public GoogleComputeEngineTemplateOptions blockOnComplete(boolean blockOnComplete)

  As of version 1.1.0, we cannot kick off a script unless a node is in RUNNING state.

  Overrides:

  blockOnComplete in class TemplateOptions

  Parameters:

  blockOnComplete - (default true) false means kick off the script in the background, but don't wait for it to finish. (as of version 1.1.0, implemented as nohup)