GoogleCloudDriver (nf-google 20.04.1 API)

nextflow.cloud.google.GoogleCloudDriver

All Implemented Interfaces and Traits:: nextflow.cloud.CloudDriver

@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
@nextflow.util.ServiceName('google')
class GoogleCloudDriver
extends java.lang.Object

Cloud driver implementation for Google Compute Engine.

Authors:: Vilmundur Pálmason

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`GCE_CREDENTIAL_FILE`
`static long`	`OPS_WAIT_TIMEOUT_MS`
`static long`	`POLL_WAIT`
`static java.lang.String`	`TERMINATION_FILENAME` The GCE zone eg.

Constructor Summary

Constructors
Constructor and description
`GoogleCloudDriver (GceApiHelper helper)` Only use for testing
`GoogleCloudDriver ()` Initialise the Google cloud driver with default (empty) parameters
`GoogleCloudDriver (java.util.Map config)` Initialise the Google cloud driver with the specified parameters

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`checkUnsupportedSettings(nextflow.cloud.LaunchConfig config)`
	`nextflow.cloud.types.CloudInstanceType`	`describeInstanceType(java.lang.String instanceType)`
	`void`	`eachInstance(groovy.lang.Closure callback)`
	`void`	`eachInstanceWithFilter(java.lang.String filter, groovy.lang.Closure callback)`
	`void`	`eachInstanceWithIds(java.util.List<java.lang.String> instanceIds, groovy.lang.Closure callback)`
	`void`	`eachInstanceWithTags(java.util.Map tags, groovy.lang.Closure callback)`
	`void`	`eachSpotPrice(java.util.List<java.lang.String> instanceTypes, groovy.lang.Closure callback)`
	`com.google.api.services.compute.Compute`	`getClient()` Gets com.google.api.services.compute.Compute instance given the current configuration parameter
	`java.lang.String`	`getLocalInstanceId()`
	`java.lang.String`	`getLocalTerminationNotice()`
	`static java.lang.String`	`instanceIdToFilterExpression(java.lang.String instanceId)`
	`java.util.List<java.lang.String>`	`launchInstances(int instanceCount, nextflow.cloud.LaunchConfig config)`
	`java.util.List<java.lang.String>`	`listPrivateIPs(java.lang.String clusterName)`
	`java.lang.String`	`scriptBashEnv(nextflow.cloud.LaunchConfig cfg)`
	`void`	`tagInstances(java.util.Collection<java.lang.String> instanceIds, java.util.Map<java.lang.String, java.lang.String> tags)`
	`static java.lang.String`	`tagToFilterExpression(java.lang.String k, java.lang.Object v)`
	`void`	`terminateInstances(java.util.Collection<java.lang.String> instanceIds)`
	`java.lang.Object`	`toNextflow(com.google.api.services.compute.model.Instance instance)`
	`void`	`validate(nextflow.cloud.LaunchConfig config)`
	`void`	`waitInstanceStatus(java.util.Collection<java.lang.String> instanceIds, nextflow.cloud.types.CloudInstanceStatus status)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.lang.String GCE_CREDENTIAL_FILE
  - static long OPS_WAIT_TIMEOUT_MS
  - static long POLL_WAIT
  - static final java.lang.String TERMINATION_FILENAME
    
    The GCE zone eg. us-central1-f. If it's not specified the current region is retrieved from the GCE instance metadata
- Constructor Detail
  - GoogleCloudDriver(GceApiHelper helper)
    
    Only use for testing
  - GoogleCloudDriver()
    
    Initialise the Google cloud driver with default (empty) parameters
  - @groovy.transform.CompileDynamic @java.lang.Deprecated GoogleCloudDriver(java.util.Map config)
    
    Initialise the Google cloud driver with the specified parameters
    Parameters:
    config - A map holding the driver parameters: - zone: the GCE zone - project: GCE project id
- Method Detail
  - protected void checkUnsupportedSettings(nextflow.cloud.LaunchConfig config)
  - @java.lang.Override nextflow.cloud.types.CloudInstanceType describeInstanceType(java.lang.String instanceType)
  - @java.lang.Override void eachInstance(@groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
  - void eachInstanceWithFilter(java.lang.String filter, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
  - @java.lang.Override void eachInstanceWithIds(java.util.List<java.lang.String> instanceIds, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
  - @java.lang.Override void eachInstanceWithTags(java.util.Map tags, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)
  - @java.lang.Override void eachSpotPrice(java.util.List<java.lang.String> instanceTypes, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudSpotPrice']) groovy.lang.Closure callback)
  - com.google.api.services.compute.Compute getClient()
    
    Gets com.google.api.services.compute.Compute instance given the current configuration parameter
    Returns:
    An com.google.api.services.compute.Compute instance
  - @java.lang.Override java.lang.String getLocalInstanceId()
  - @java.lang.Override java.lang.String getLocalTerminationNotice()
  - static java.lang.String instanceIdToFilterExpression(java.lang.String instanceId)
  - @java.lang.Override java.util.List<java.lang.String> launchInstances(int instanceCount, nextflow.cloud.LaunchConfig config)
  - @java.lang.Override java.util.List<java.lang.String> listPrivateIPs(java.lang.String clusterName)
  - java.lang.String scriptBashEnv(nextflow.cloud.LaunchConfig cfg)
  - @java.lang.Override void tagInstances(java.util.Collection<java.lang.String> instanceIds, java.util.Map<java.lang.String, java.lang.String> tags)
  - static java.lang.String tagToFilterExpression(java.lang.String k, java.lang.Object v)
  - @java.lang.Override void terminateInstances(java.util.Collection<java.lang.String> instanceIds)
  - java.lang.Object toNextflow(com.google.api.services.compute.model.Instance instance)
  - @java.lang.Override void validate(nextflow.cloud.LaunchConfig config)
  - @java.lang.Override void waitInstanceStatus(java.util.Collection<java.lang.String> instanceIds, nextflow.cloud.types.CloudInstanceStatus status)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GoogleCloudDriver

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String GCE_CREDENTIAL_FILE

static long OPS_WAIT_TIMEOUT_MS

static long POLL_WAIT

static final java.lang.String TERMINATION_FILENAME

Constructor Detail

GoogleCloudDriver(GceApiHelper helper)

GoogleCloudDriver()

@groovy.transform.CompileDynamic @java.lang.Deprecated GoogleCloudDriver(java.util.Map config)

Method Detail

protected void checkUnsupportedSettings(nextflow.cloud.LaunchConfig config)

@java.lang.Override nextflow.cloud.types.CloudInstanceType describeInstanceType(java.lang.String instanceType)

@java.lang.Override void eachInstance(@groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

void eachInstanceWithFilter(java.lang.String filter, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

@java.lang.Override void eachInstanceWithIds(java.util.List<java.lang.String> instanceIds, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

@java.lang.Override void eachInstanceWithTags(java.util.Map tags, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudInstance']) groovy.lang.Closure callback)

@java.lang.Override void eachSpotPrice(java.util.List<java.lang.String> instanceTypes, @groovy.transform.stc.ClosureParams(value = SimpleType, options = ['nextflow.cloud.types.CloudSpotPrice']) groovy.lang.Closure callback)

com.google.api.services.compute.Compute getClient()

@java.lang.Override java.lang.String getLocalInstanceId()

@java.lang.Override java.lang.String getLocalTerminationNotice()

static java.lang.String instanceIdToFilterExpression(java.lang.String instanceId)

@java.lang.Override java.util.List<java.lang.String> launchInstances(int instanceCount, nextflow.cloud.LaunchConfig config)

@java.lang.Override java.util.List<java.lang.String> listPrivateIPs(java.lang.String clusterName)

java.lang.String scriptBashEnv(nextflow.cloud.LaunchConfig cfg)

@java.lang.Override void tagInstances(java.util.Collection<java.lang.String> instanceIds, java.util.Map<java.lang.String, java.lang.String> tags)

static java.lang.String tagToFilterExpression(java.lang.String k, java.lang.Object v)

@java.lang.Override void terminateInstances(java.util.Collection<java.lang.String> instanceIds)

java.lang.Object toNextflow(com.google.api.services.compute.model.Instance instance)

@java.lang.Override void validate(nextflow.cloud.LaunchConfig config)

@java.lang.Override void waitInstanceStatus(java.util.Collection<java.lang.String> instanceIds, nextflow.cloud.types.CloudInstanceStatus status)