AzureSlaveTemplate (Azure Slave Plugin 0.1.0 API)

java.lang.Object
- com.microsoftopentechnologies.azure.AzureSlaveTemplate

All Implemented Interfaces:

hudson.model.Describable<AzureSlaveTemplate>
```
public class AzureSlaveTemplate
extends Object
implements hudson.model.Describable<AzureSlaveTemplate>
```
This class defines the configuration of Azure instance templates

Author:

Suresh Nallamilli

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AzureSlaveTemplate.DescriptorImpl

Nested Classes
Modifier and Type	Class and Description
`static class`	`AzureSlaveTemplate.DescriptorImpl`

Field Summary

Fields
Modifier and Type Field and Description

AzureCloud azureCloud

Fields
Modifier and Type	Field and Description
`AzureCloud`	`azureCloud`

Constructor Summary

Constructors
Constructor and Description
`AzureSlaveTemplate(String templateName, String templateDesc, String labels, String location, String virtualMachineSize, String storageAccountName, String noOfParallelJobs, hudson.model.Node.Mode useSlaveAlwaysIfAvail, String imageIdOrFamily, String slaveLaunchMethod, String initScript, String adminUserName, String adminPassword, String slaveWorkSpace, String jvmOptions, String cloudServiceName, String retentionTimeInMin, String templateStatus, String templateStatusDetails)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`disableTemplate(String message)`
`String`	`getAdminPassword()`
`String`	`getAdminUserName()`
`AzureCloud`	`getAzureCloud()`
`String`	`getCloudServiceName()`
`hudson.model.Descriptor<AzureSlaveTemplate>`	`getDescriptor()`
`String`	`getImageIdOrFamily()`
`String`	`getInitScript()`
`String`	`getJvmOptions()`
`Set<hudson.model.labels.LabelAtom>`	`getLabelDataSet()`
`String`	`getLabels()`
`String`	`getLocation()`
`int`	`getNoOfParallelJobs()`
`int`	`getRetentionTimeInMin()`
`String`	`getSlaveLaunchMethod()`
`String`	`getSlaveWorkSpace()`
`String`	`getStorageAccountName()`
`String`	`getTemplateDesc()`
`String`	`getTemplateName()`
`String`	`getTemplateStatus()`
`String`	`getTemplateStatusDetails()`
`hudson.model.Node.Mode`	`getUseSlaveAlwaysIfAvail()`
`int`	`getVirtualMachineCount()`
`String`	`getVirtualMachineSize()`
`boolean`	`isShutdownOnIdle()`
`AzureSlave`	`provisionSlave(hudson.model.TaskListener listener)`
`void`	`setStorageAccountName(String storageAccountName)`
`void`	`setTemplateStatus(String templateStatus)`
`void`	`setTemplateStatusDetails(String templateStatusDetails)`
`void`	`setVirtualMachineDetails(AzureSlave slave)`
`List<String>`	`verifyTemplate()`
`void`	`waitForReadyRole(AzureSlave slave)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- azureCloud
```
public transient AzureCloud azureCloud
```

Constructor Detail

AzureSlaveTemplate

@DataBoundConstructor
public AzureSlaveTemplate(String templateName,
                                       String templateDesc,
                                       String labels,
                                       String location,
                                       String virtualMachineSize,
                                       String storageAccountName,
                                       String noOfParallelJobs,
                                       hudson.model.Node.Mode useSlaveAlwaysIfAvail,
                                       String imageIdOrFamily,
                                       String slaveLaunchMethod,
                                       String initScript,
                                       String adminUserName,
                                       String adminPassword,
                                       String slaveWorkSpace,
                                       String jvmOptions,
                                       String cloudServiceName,
                                       String retentionTimeInMin,
                                       String templateStatus,
                                       String templateStatusDetails)

Method Detail

getLabels
```
public String getLabels()
```

getLocation
```
public String getLocation()
```

getVirtualMachineSize
```
public String getVirtualMachineSize()
```

getStorageAccountName
```
public String getStorageAccountName()
```

setStorageAccountName

public void setStorageAccountName(String storageAccountName)

getUseSlaveAlwaysIfAvail

public hudson.model.Node.Mode getUseSlaveAlwaysIfAvail()

isShutdownOnIdle
```
public boolean isShutdownOnIdle()
```

getImageIdOrFamily
```
public String getImageIdOrFamily()
```

getInitScript
```
public String getInitScript()
```

getAdminUserName
```
public String getAdminUserName()
```

getAdminPassword
```
public String getAdminPassword()
```

getSlaveWorkSpace
```
public String getSlaveWorkSpace()
```

getRetentionTimeInMin
```
public int getRetentionTimeInMin()
```

getJvmOptions
```
public String getJvmOptions()
```

getCloudServiceName
```
public String getCloudServiceName()
```

getAzureCloud
```
public AzureCloud getAzureCloud()
```

getTemplateName
```
public String getTemplateName()
```

getTemplateDesc
```
public String getTemplateDesc()
```

getNoOfParallelJobs
```
public int getNoOfParallelJobs()
```

getSlaveLaunchMethod
```
public String getSlaveLaunchMethod()
```

setTemplateStatus

public void setTemplateStatus(String templateStatus)

getTemplateStatus
```
public String getTemplateStatus()
```

getTemplateStatusDetails

public String getTemplateStatusDetails()

setTemplateStatusDetails

public void setTemplateStatusDetails(String templateStatusDetails)

getDescriptor
```
public hudson.model.Descriptor<AzureSlaveTemplate> getDescriptor()
```
Specified by:

getDescriptor in interface hudson.model.Describable<AzureSlaveTemplate>

getLabelDataSet

public Set<hudson.model.labels.LabelAtom> getLabelDataSet()

provisionSlave

public AzureSlave provisionSlave(hudson.model.TaskListener listener)
                          throws Exception

Throws:: Exception

waitForReadyRole

public void waitForReadyRole(AzureSlave slave)
                      throws Exception

Throws:: Exception

disableTemplate

public void disableTemplate(String message)

getVirtualMachineCount

public int getVirtualMachineCount()
                           throws Exception

Throws:: Exception

verifyTemplate

public List<String> verifyTemplate()
                            throws Exception

Throws:: Exception

setVirtualMachineDetails

public void setVirtualMachineDetails(AzureSlave slave)
                              throws Exception

Throws:: Exception

Class AzureSlaveTemplate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

azureCloud

Constructor Detail

AzureSlaveTemplate

Method Detail

getLabels

getLocation

getVirtualMachineSize

getStorageAccountName

setStorageAccountName

getUseSlaveAlwaysIfAvail

isShutdownOnIdle

getImageIdOrFamily

getInitScript

getAdminUserName

getAdminPassword

getSlaveWorkSpace

getRetentionTimeInMin

getJvmOptions

getCloudServiceName

getAzureCloud

getTemplateName

getTemplateDesc

getNoOfParallelJobs

getSlaveLaunchMethod

setTemplateStatus

getTemplateStatus

getTemplateStatusDetails

setTemplateStatusDetails

getDescriptor

getLabelDataSet

provisionSlave

waitForReadyRole

disableTemplate

getVirtualMachineCount

verifyTemplate

setVirtualMachineDetails