Package com.google.jenkins.plugins.computeengine

Class InstanceConfiguration

java.lang.Object

com.google.jenkins.plugins.computeengine.InstanceConfiguration

All Implemented Interfaces:

Describable<InstanceConfiguration>

public class InstanceConfiguration
extends Object
implements Describable<InstanceConfiguration>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InstanceConfiguration.Builder
static final class	InstanceConfiguration.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected ComputeEngineCloud	cloud
static final Long	DEFAULT_BOOT_DISK_SIZE_GB
static final Integer	DEFAULT_LAUNCH_TIMEOUT_SECONDS
static final Integer	DEFAULT_NUM_EXECUTORS
static final Integer	DEFAULT_RETENTION_TIME_MINUTES
static final String	DEFAULT_RUN_AS_USER
static final String	GUEST_ATTRIBUTES_METADATA_KEY
static final List<String>	KNOWN_IMAGE_PROJECTS
static final String	METADATA_LINUX_STARTUP_SCRIPT_KEY
static final String	METADATA_WINDOWS_STARTUP_SCRIPT_KEY
static final String	SSH_METADATA_KEY

Constructor Summary

Constructors

Constructor	Description
InstanceConfiguration()
InstanceConfiguration(String description, String namePrefix, String region, String zone, String machineType, String numExecutorsStr, String startupScript, boolean preemptible, String minCpuPlatform, String labels, String runAsUser, String bootDiskType, boolean bootDiskAutoDelete, String bootDiskSourceImageName, String bootDiskSourceImageProject, NetworkConfiguration networkConfiguration, NetworkInterfaceIpStackMode networkInterfaceIpStackMode, Boolean externalAddress, boolean useInternalAddress, boolean ignoreProxy, String networkTags, String serviceAccountEmail, Node.Mode mode, AcceleratorConfiguration acceleratorConfiguration, String retentionTimeMinutesStr, String launchTimeoutSecondsStr, String bootDiskSizeGbStr, boolean oneShot, String template, WindowsConfiguration windowsConfiguration, SshConfiguration sshConfiguration, boolean createSnapshot, String remoteFs, String javaExecPath, GoogleKeyCredential sshKeyCredential, Map<String,String> googleLabels, Integer numExecutors, Integer retentionTimeMinutes, Integer launchTimeoutSeconds, Long bootDiskSizeGb, Set<LabelAtom> labelSet, ComputeEngineCloud cloud)

Method Summary

Modifier and Type	Method	Description
void	appendLabel(String key, String value)
void	appendLabels(Map<String,String> labels)
static InstanceConfiguration.Builder	builder()
AcceleratorConfiguration	getAcceleratorConfiguration()
Long	getBootDiskSizeGb()
String	getBootDiskSizeGbStr()
String	getBootDiskSourceImageName()
String	getBootDiskSourceImageProject()
String	getBootDiskType()
protected ComputeEngineCloud	getCloud()
String	getDescription()
Descriptor<InstanceConfiguration>	getDescriptor()
String	getDisplayName()
Boolean	getExternalAddress()	Deprecated.
Map<String,String>	getGoogleLabels()
String	getJavaExecPath()
String	getLabels()
Set<LabelAtom>	getLabelSet()
String	getLabelString()
int	getLaunchTimeoutMillis()
Integer	getLaunchTimeoutSeconds()
String	getLaunchTimeoutSecondsStr()
String	getMachineType()
String	getMinCpuPlatform()
Node.Mode	getMode()
String	getNamePrefix()
NetworkConfiguration	getNetworkConfiguration()
NetworkInterfaceIpStackMode	getNetworkInterfaceIpStackMode()
String	getNetworkTags()
Integer	getNumExecutors()
String	getNumExecutorsStr()
String	getRegion()
String	getRemoteFs()
Integer	getRetentionTimeMinutes()
String	getRetentionTimeMinutesStr()
String	getRunAsUser()
String	getServiceAccountEmail()
SshConfiguration	getSshConfiguration()
GoogleKeyCredential	getSshKeyCredential()
String	getStartupScript()
String	getTemplate()
WindowsConfiguration	getWindowsConfiguration()
String	getZone()
com.google.api.services.compute.model.Instance	instance()
static Integer	intOrDefault(String toParse, Integer defaultTo)
boolean	isBootDiskAutoDelete()
boolean	isCreateSnapshot()
boolean	isIgnoreProxy()
boolean	isOneShot()
boolean	isPreemptible()
boolean	isUseInternalAddress()
static Long	longOrDefault(String toParse, Long defaultTo)
ComputeEngineInstance	provision()
protected Object	readResolve()	Initializes transient properties
void	setAcceleratorConfiguration(AcceleratorConfiguration acceleratorConfiguration)
void	setBootDiskAutoDelete(boolean bootDiskAutoDelete)
void	setBootDiskSizeGb(Long bootDiskSizeGb)
void	setBootDiskSizeGbStr(String bootDiskSizeGbStr)
void	setBootDiskSourceImageName(String bootDiskSourceImageName)
void	setBootDiskSourceImageProject(String bootDiskSourceImageProject)
void	setBootDiskType(String bootDiskType)
protected void	setCloud(ComputeEngineCloud cloud)
void	setCreateSnapshot(boolean createSnapshot)
void	setDescription(String description)
void	setExternalAddress(Boolean externalAddress)	Deprecated.
void	setGoogleLabels(Map<String,String> googleLabels)
void	setIgnoreProxy(boolean ignoreProxy)
void	setJavaExecPath(String javaExecPath)
void	setLabels(String labels)
void	setLabelSet(Set<LabelAtom> labelSet)
void	setLabelString(String labelString)
void	setLaunchTimeoutSeconds(Integer launchTimeoutSeconds)
void	setLaunchTimeoutSecondsStr(String launchTimeoutSecondsStr)
void	setMachineType(String machineType)
void	setMinCpuPlatform(String minCpuPlatform)
void	setMode(Node.Mode mode)
void	setNamePrefix(String namePrefix)
void	setNetworkConfiguration(NetworkConfiguration networkConfiguration)
void	setNetworkInterfaceIpStackMode(NetworkInterfaceIpStackMode networkInterfaceIpStackMode)
void	setNetworkTags(String networkTags)
void	setNumExecutors(Integer numExecutors)
void	setNumExecutorsStr(String numExecutorsStr)
void	setOneShot(boolean oneShot)
void	setPreemptible(boolean preemptible)
void	setRegion(String region)
void	setRemoteFs(String remoteFs)
void	setRetentionTimeMinutes(Integer retentionTimeMinutes)
void	setRetentionTimeMinutesStr(String retentionTimeMinutesStr)
void	setRunAsUser(String runAsUser)
void	setServiceAccountEmail(String serviceAccountEmail)
void	setSshConfiguration(SshConfiguration sshConfiguration)
void	setSshKeyCredential(GoogleKeyCredential sshKeyCredential)
void	setStartupScript(String startupScript)
void	setTemplate(String template)
void	setUseInternalAddress(boolean useInternalAddress)
void	setWindowsConfiguration(WindowsConfiguration windowsConfiguration)
void	setZone(String zone)

Methods inherited from class java.lang.Object

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

Field Details

GUEST_ATTRIBUTES_METADATA_KEY

public static final String GUEST_ATTRIBUTES_METADATA_KEY

See Also:

• Constant Field Values

SSH_METADATA_KEY

public static final String SSH_METADATA_KEY

See Also:

• Constant Field Values

DEFAULT_BOOT_DISK_SIZE_GB

public static final Long DEFAULT_BOOT_DISK_SIZE_GB

DEFAULT_NUM_EXECUTORS

public static final Integer DEFAULT_NUM_EXECUTORS

DEFAULT_LAUNCH_TIMEOUT_SECONDS

public static final Integer DEFAULT_LAUNCH_TIMEOUT_SECONDS

DEFAULT_RETENTION_TIME_MINUTES

public static final Integer DEFAULT_RETENTION_TIME_MINUTES

DEFAULT_RUN_AS_USER

public static final String DEFAULT_RUN_AS_USER

See Also:

• Constant Field Values

METADATA_LINUX_STARTUP_SCRIPT_KEY

public static final String METADATA_LINUX_STARTUP_SCRIPT_KEY

See Also:

• Constant Field Values

METADATA_WINDOWS_STARTUP_SCRIPT_KEY

public static final String METADATA_WINDOWS_STARTUP_SCRIPT_KEY

See Also:

• Constant Field Values

KNOWN_IMAGE_PROJECTS

public static final List<String> KNOWN_IMAGE_PROJECTS

cloud

protected transient ComputeEngineCloud cloud

Constructor Details

InstanceConfiguration

@DataBoundConstructor
public InstanceConfiguration()

InstanceConfiguration

public InstanceConfiguration(String description,
 String namePrefix,
 String region,
 String zone,
 String machineType,
 String numExecutorsStr,
 String startupScript,
 boolean preemptible,
 String minCpuPlatform,
 String labels,
 String runAsUser,
 String bootDiskType,
 boolean bootDiskAutoDelete,
 String bootDiskSourceImageName,
 String bootDiskSourceImageProject,
 NetworkConfiguration networkConfiguration,
 NetworkInterfaceIpStackMode networkInterfaceIpStackMode,
 Boolean externalAddress,
 boolean useInternalAddress,
 boolean ignoreProxy,
 String networkTags,
 String serviceAccountEmail,
 Node.Mode mode,
 AcceleratorConfiguration acceleratorConfiguration,
 String retentionTimeMinutesStr,
 String launchTimeoutSecondsStr,
 String bootDiskSizeGbStr,
 boolean oneShot,
 String template,
 @Nullable
 WindowsConfiguration windowsConfiguration,
 @Nullable
 SshConfiguration sshConfiguration,
 boolean createSnapshot,
 String remoteFs,
 String javaExecPath,
 GoogleKeyCredential sshKeyCredential,
 Map<String,String> googleLabels,
 Integer numExecutors,
 Integer retentionTimeMinutes,
 Integer launchTimeoutSeconds,
 Long bootDiskSizeGb,
 Set<LabelAtom> labelSet,
 ComputeEngineCloud cloud)

Method Details

setNumExecutorsStr

@DataBoundSetter
public void setNumExecutorsStr(String numExecutorsStr)

setLabelString

@DataBoundSetter
public void setLabelString(String labelString)

setNetworkTags

@DataBoundSetter
public void setNetworkTags(String networkTags)

setRetentionTimeMinutesStr

@DataBoundSetter
public void setRetentionTimeMinutesStr(String retentionTimeMinutesStr)

setLaunchTimeoutSecondsStr

@DataBoundSetter
public void setLaunchTimeoutSecondsStr(String launchTimeoutSecondsStr)

setBootDiskSizeGbStr

@DataBoundSetter
public void setBootDiskSizeGbStr(String bootDiskSizeGbStr)

setOneShot

@DataBoundSetter
public void setOneShot(boolean oneShot)

setCreateSnapshot

@DataBoundSetter
public void setCreateSnapshot(boolean createSnapshot)

intOrDefault

public static Integer intOrDefault(String toParse,
 Integer defaultTo)

longOrDefault

public static Long longOrDefault(String toParse,
 Long defaultTo)

getDescriptor

public Descriptor<InstanceConfiguration> getDescriptor()

Specified by:

getDescriptor in interface Describable<InstanceConfiguration>

getLabelString

public String getLabelString()

getLabelSet

public Set<LabelAtom> getLabelSet()

getDisplayName

public String getDisplayName()

getLaunchTimeoutMillis

public int getLaunchTimeoutMillis()

appendLabels

public void appendLabels(Map<String,String> labels)

appendLabel

public void appendLabel(String key,
 String value)

provision

public ComputeEngineInstance provision()
                                throws IOException

Throws:

IOException

readResolve

protected Object readResolve()

Initializes transient properties

instance

public com.google.api.services.compute.model.Instance instance()
                                                        throws IOException

Throws:

IOException

builder

public static InstanceConfiguration.Builder builder()

getDescription

public String getDescription()

getNamePrefix

public String getNamePrefix()

getRegion

public String getRegion()

getZone

public String getZone()

getMachineType

public String getMachineType()

getNumExecutorsStr

public String getNumExecutorsStr()

getStartupScript

public String getStartupScript()

isPreemptible

public boolean isPreemptible()

getMinCpuPlatform

public String getMinCpuPlatform()

getLabels

public String getLabels()

getRunAsUser

public String getRunAsUser()

getBootDiskType

public String getBootDiskType()

isBootDiskAutoDelete

public boolean isBootDiskAutoDelete()

getBootDiskSourceImageName

public String getBootDiskSourceImageName()

getBootDiskSourceImageProject

public String getBootDiskSourceImageProject()

getNetworkConfiguration

public NetworkConfiguration getNetworkConfiguration()

getNetworkInterfaceIpStackMode

public NetworkInterfaceIpStackMode getNetworkInterfaceIpStackMode()

getExternalAddress

@Deprecated
public Boolean getExternalAddress()

Deprecated.

isUseInternalAddress

public boolean isUseInternalAddress()

isIgnoreProxy

public boolean isIgnoreProxy()

getNetworkTags

public String getNetworkTags()

getServiceAccountEmail

public String getServiceAccountEmail()

getMode

public Node.Mode getMode()

getAcceleratorConfiguration

public AcceleratorConfiguration getAcceleratorConfiguration()

getRetentionTimeMinutesStr

public String getRetentionTimeMinutesStr()

getLaunchTimeoutSecondsStr

public String getLaunchTimeoutSecondsStr()

getBootDiskSizeGbStr

public String getBootDiskSizeGbStr()

isOneShot

public boolean isOneShot()

getTemplate

public String getTemplate()

getWindowsConfiguration

@Nullable
public WindowsConfiguration getWindowsConfiguration()

getSshConfiguration

@Nullable
public SshConfiguration getSshConfiguration()

isCreateSnapshot

public boolean isCreateSnapshot()

getRemoteFs

public String getRemoteFs()

getJavaExecPath

public String getJavaExecPath()

getSshKeyCredential

public GoogleKeyCredential getSshKeyCredential()

getGoogleLabels

public Map<String,String> getGoogleLabels()

getNumExecutors

public Integer getNumExecutors()

getRetentionTimeMinutes

public Integer getRetentionTimeMinutes()

getLaunchTimeoutSeconds

public Integer getLaunchTimeoutSeconds()

getBootDiskSizeGb

public Long getBootDiskSizeGb()

setDescription

@DataBoundSetter
public void setDescription(String description)

setNamePrefix

@DataBoundSetter
public void setNamePrefix(String namePrefix)

setRegion

@DataBoundSetter
public void setRegion(String region)

setZone

@DataBoundSetter
public void setZone(String zone)

setMachineType

@DataBoundSetter
public void setMachineType(String machineType)

setStartupScript

@DataBoundSetter
public void setStartupScript(String startupScript)

setPreemptible

@DataBoundSetter
public void setPreemptible(boolean preemptible)

setMinCpuPlatform

@DataBoundSetter
public void setMinCpuPlatform(String minCpuPlatform)

setLabels

@DataBoundSetter
public void setLabels(String labels)

setRunAsUser

@DataBoundSetter
public void setRunAsUser(String runAsUser)

setBootDiskType

@DataBoundSetter
public void setBootDiskType(String bootDiskType)

setBootDiskAutoDelete

@DataBoundSetter
public void setBootDiskAutoDelete(boolean bootDiskAutoDelete)

setBootDiskSourceImageName

@DataBoundSetter
public void setBootDiskSourceImageName(String bootDiskSourceImageName)

setBootDiskSourceImageProject

@DataBoundSetter
public void setBootDiskSourceImageProject(String bootDiskSourceImageProject)

setNetworkConfiguration

@DataBoundSetter
public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)

setNetworkInterfaceIpStackMode

@DataBoundSetter
public void setNetworkInterfaceIpStackMode(NetworkInterfaceIpStackMode networkInterfaceIpStackMode)

setExternalAddress

@Deprecated
@DataBoundSetter
public void setExternalAddress(Boolean externalAddress)

Deprecated.

setUseInternalAddress

@DataBoundSetter
public void setUseInternalAddress(boolean useInternalAddress)

setIgnoreProxy

@DataBoundSetter
public void setIgnoreProxy(boolean ignoreProxy)

setServiceAccountEmail

@DataBoundSetter
public void setServiceAccountEmail(String serviceAccountEmail)

setMode

@DataBoundSetter
public void setMode(Node.Mode mode)

setAcceleratorConfiguration

@DataBoundSetter
public void setAcceleratorConfiguration(AcceleratorConfiguration acceleratorConfiguration)

setTemplate

@DataBoundSetter
public void setTemplate(String template)

setWindowsConfiguration

@DataBoundSetter
public void setWindowsConfiguration(@Nullable
 WindowsConfiguration windowsConfiguration)

setSshConfiguration

@DataBoundSetter
public void setSshConfiguration(@Nullable
 SshConfiguration sshConfiguration)

setRemoteFs

@DataBoundSetter
public void setRemoteFs(String remoteFs)

setJavaExecPath

@DataBoundSetter
public void setJavaExecPath(String javaExecPath)

setSshKeyCredential

@DataBoundSetter
public void setSshKeyCredential(GoogleKeyCredential sshKeyCredential)

setGoogleLabels

@DataBoundSetter
public void setGoogleLabels(Map<String,String> googleLabels)

setNumExecutors

@DataBoundSetter
public void setNumExecutors(Integer numExecutors)

setRetentionTimeMinutes

@DataBoundSetter
public void setRetentionTimeMinutes(Integer retentionTimeMinutes)

setLaunchTimeoutSeconds

@DataBoundSetter
public void setLaunchTimeoutSeconds(Integer launchTimeoutSeconds)

setBootDiskSizeGb

@DataBoundSetter
public void setBootDiskSizeGb(Long bootDiskSizeGb)

setLabelSet

@DataBoundSetter
public void setLabelSet(Set<LabelAtom> labelSet)

getCloud

protected ComputeEngineCloud getCloud()

setCloud

protected void setCloud(ComputeEngineCloud cloud)