CloudPool Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. CloudPool
- com.
public class CloudPool
A pool in the Azure Batch service.
Method Summary
Modifier and Type | Method and Description |
---|---|
Allocation |
allocationState()
Get possible values include: 'steady', 'resizing', 'stopping'. |
DateTime |
allocationStateTransitionTime()
Get the allocationStateTransitionTime value. |
List<String> |
applicationLicenses()
Get the list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. |
List<Application |
applicationPackageReferences()
Get the applicationPackageReferences value. |
Period |
autoScaleEvaluationInterval()
Get this property is set only if the pool automatically scales, i.e. enableAutoScale is true. |
String |
autoScaleFormula()
Get this property is set only if the pool automatically scales, i.e. enableAutoScale is true. |
Auto |
autoScaleRun()
Get this property is set only if the pool automatically scales, i.e. enableAutoScale is true. |
List<Certificate |
certificateReferences()
Get for Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. |
Cloud |
cloudServiceConfiguration()
Get this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'. |
DateTime |
creationTime()
Get the creationTime value. |
Integer |
currentDedicatedNodes()
Get the currentDedicatedNodes value. |
Integer |
currentLowPriorityNodes()
Get low-priority compute nodes which have been preempted are included in this count. |
String |
displayName()
Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
Boolean |
enableAutoScale()
Get if false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false. |
Boolean |
enableInterNodeCommunication()
Get this imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool. |
String |
eTag()
Get this is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime. |
String |
id()
Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case). |
DateTime |
lastModified()
Get this is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state. |
Integer |
maxTasksPerNode()
Get the maxTasksPerNode value. |
List<Metadata |
metadata()
Get the metadata value. |
Network |
networkConfiguration()
Get the networkConfiguration value. |
List<Resize |
resizeErrors()
Get this property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady. |
Period |
resizeTimeout()
Get this is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes. |
Start |
startTask()
Get the startTask value. |
Pool |
state()
Get possible values include: 'active', 'deleting'. |
DateTime |
stateTransitionTime()
Get the stateTransitionTime value. |
Pool |
stats()
Get the stats value. |
Integer |
targetDedicatedNodes()
Get the targetDedicatedNodes value. |
Integer |
targetLowPriorityNodes()
Get the targetLowPriorityNodes value. |
Task |
taskSchedulingPolicy()
Get the taskSchedulingPolicy value. |
String |
url()
Get the url value. |
List<User |
userAccounts()
Get the userAccounts value. |
Virtual |
virtualMachineConfiguration()
Get this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. |
String |
vmSize()
Get for information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). |
Cloud |
withAllocationState(AllocationState allocationState)
Set possible values include: 'steady', 'resizing', 'stopping'. |
Cloud |
withAllocationStateTransitionTime(DateTime allocationStateTransitionTime)
Set the allocationStateTransitionTime value. |
Cloud |
withApplicationLicenses(List<String> applicationLicenses)
Set the list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. |
Cloud |
withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)
Set the applicationPackageReferences value. |
Cloud |
withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)
Set this property is set only if the pool automatically scales, i.e. enableAutoScale is true. |
Cloud |
withAutoScaleFormula(String autoScaleFormula)
Set this property is set only if the pool automatically scales, i.e. enableAutoScale is true. |
Cloud |
withAutoScaleRun(AutoScaleRun autoScaleRun)
Set this property is set only if the pool automatically scales, i.e. enableAutoScale is true. |
Cloud |
withCertificateReferences(List<CertificateReference> certificateReferences)
Set for Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. |
Cloud |
withCloudServiceConfiguration(CloudServiceConfiguration cloudServiceConfiguration)
Set this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'. |
Cloud |
withCreationTime(DateTime creationTime)
Set the creationTime value. |
Cloud |
withCurrentDedicatedNodes(Integer currentDedicatedNodes)
Set the currentDedicatedNodes value. |
Cloud |
withCurrentLowPriorityNodes(Integer currentLowPriorityNodes)
Set low-priority compute nodes which have been preempted are included in this count. |
Cloud |
withDisplayName(String displayName)
Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
Cloud |
withEnableAutoScale(Boolean enableAutoScale)
Set if false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false. |
Cloud |
withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)
Set this imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool. |
Cloud |
withETag(String eTag)
Set this is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime. |
Cloud |
withId(String id)
Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case). |
Cloud |
withLastModified(DateTime lastModified)
Set this is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state. |
Cloud |
withMaxTasksPerNode(Integer maxTasksPerNode)
Set the maxTasksPerNode value. |
Cloud |
withMetadata(List<MetadataItem> metadata)
Set the metadata value. |
Cloud |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Set the networkConfiguration value. |
Cloud |
withResizeErrors(List<ResizeError> resizeErrors)
Set this property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady. |
Cloud |
withResizeTimeout(Period resizeTimeout)
Set this is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes. |
Cloud |
withStartTask(StartTask startTask)
Set the startTask value. |
Cloud |
withState(PoolState state)
Set possible values include: 'active', 'deleting'. |
Cloud |
withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value. |
Cloud |
withStats(PoolStatistics stats)
Set the stats value. |
Cloud |
withTargetDedicatedNodes(Integer targetDedicatedNodes)
Set the targetDedicatedNodes value. |
Cloud |
withTargetLowPriorityNodes(Integer targetLowPriorityNodes)
Set the targetLowPriorityNodes value. |
Cloud |
withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)
Set the taskSchedulingPolicy value. |
Cloud |
withUrl(String url)
Set the url value. |
Cloud |
withUserAccounts(List<UserAccount> userAccounts)
Set the userAccounts value. |
Cloud |
withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. |
Cloud |
withVmSize(String vmSize)
Set for information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). |
Method Details
allocationState
public AllocationState allocationState()
Get possible values include: 'steady', 'resizing', 'stopping'.
Returns:
allocationStateTransitionTime
public DateTime allocationStateTransitionTime()
Get the allocationStateTransitionTime value.
Returns:
applicationLicenses
public List
Get the list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
Returns:
applicationPackageReferences
public List
Get the applicationPackageReferences value.
Returns:
autoScaleEvaluationInterval
public Period autoScaleEvaluationInterval()
Get this property is set only if the pool automatically scales, i.e. enableAutoScale is true.
Returns:
autoScaleFormula
public String autoScaleFormula()
Get this property is set only if the pool automatically scales, i.e. enableAutoScale is true.
Returns:
autoScaleRun
public AutoScaleRun autoScaleRun()
Get this property is set only if the pool automatically scales, i.e. enableAutoScale is true.
Returns:
certificateReferences
public List
Get for Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
Returns:
cloudServiceConfiguration
public CloudServiceConfiguration cloudServiceConfiguration()
Get this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.
Returns:
creationTime
public DateTime creationTime()
Get the creationTime value.
Returns:
currentDedicatedNodes
public Integer currentDedicatedNodes()
Get the currentDedicatedNodes value.
Returns:
currentLowPriorityNodes
public Integer currentLowPriorityNodes()
Get low-priority compute nodes which have been preempted are included in this count.
Returns:
displayName
public String displayName()
Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
Returns:
enableAutoScale
public Boolean enableAutoScale()
Get if false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.
Returns:
enableInterNodeCommunication
public Boolean enableInterNodeCommunication()
Get this imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool.
Returns:
eTag
public String eTag()
Get this is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime.
Returns:
id
public String id()
Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
Returns:
lastModified
public DateTime lastModified()
Get this is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state.
Returns:
maxTasksPerNode
public Integer maxTasksPerNode()
Get the maxTasksPerNode value.
Returns:
metadata
public List
Get the metadata value.
Returns:
networkConfiguration
public NetworkConfiguration networkConfiguration()
Get the networkConfiguration value.
Returns:
resizeErrors
public List
Get this property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady.
Returns:
resizeTimeout
public Period resizeTimeout()
Get this is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes.
Returns:
startTask
public StartTask startTask()
Get the startTask value.
Returns:
state
public PoolState state()
Get possible values include: 'active', 'deleting'.
Returns:
stateTransitionTime
public DateTime stateTransitionTime()
Get the stateTransitionTime value.
Returns:
stats
public PoolStatistics stats()
Get the stats value.
Returns:
targetDedicatedNodes
public Integer targetDedicatedNodes()
Get the targetDedicatedNodes value.
Returns:
targetLowPriorityNodes
public Integer targetLowPriorityNodes()
Get the targetLowPriorityNodes value.
Returns:
taskSchedulingPolicy
public TaskSchedulingPolicy taskSchedulingPolicy()
Get the taskSchedulingPolicy value.
Returns:
url
public String url()
Get the url value.
Returns:
userAccounts
public List
Get the userAccounts value.
Returns:
virtualMachineConfiguration
public VirtualMachineConfiguration virtualMachineConfiguration()
Get this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
Returns:
vmSize
public String vmSize()
Get for information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
Returns:
withAllocationState
public CloudPool withAllocationState(AllocationState allocationState)
Set possible values include: 'steady', 'resizing', 'stopping'.
Parameters:
Returns:
withAllocationStateTransitionTime
public CloudPool withAllocationStateTransitionTime(DateTime allocationStateTransitionTime)
Set the allocationStateTransitionTime value.
Parameters:
Returns:
withApplicationLicenses
public CloudPool withApplicationLicenses(List
Set the list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
Parameters:
Returns:
withApplicationPackageReferences
public CloudPool withApplicationPackageReferences(List
Set the applicationPackageReferences value.
Parameters:
Returns:
withAutoScaleEvaluationInterval
public CloudPool withAutoScaleEvaluationInterval(Period autoScaleEvaluationInterval)
Set this property is set only if the pool automatically scales, i.e. enableAutoScale is true.
Parameters:
Returns:
withAutoScaleFormula
public CloudPool withAutoScaleFormula(String autoScaleFormula)
Set this property is set only if the pool automatically scales, i.e. enableAutoScale is true.
Parameters:
Returns:
withAutoScaleRun
public CloudPool withAutoScaleRun(AutoScaleRun autoScaleRun)
Set this property is set only if the pool automatically scales, i.e. enableAutoScale is true.
Parameters:
Returns:
withCertificateReferences
public CloudPool withCertificateReferences(List
Set for Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
Parameters:
Returns:
withCloudServiceConfiguration
public CloudPool withCloudServiceConfiguration(CloudServiceConfiguration cloudServiceConfiguration)
Set this property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.
Parameters:
Returns:
withCreationTime
public CloudPool withCreationTime(DateTime creationTime)
Set the creationTime value.
Parameters:
Returns:
withCurrentDedicatedNodes
public CloudPool withCurrentDedicatedNodes(Integer currentDedicatedNodes)
Set the currentDedicatedNodes value.
Parameters:
Returns:
withCurrentLowPriorityNodes
public CloudPool withCurrentLowPriorityNodes(Integer currentLowPriorityNodes)
Set low-priority compute nodes which have been preempted are included in this count.
Parameters:
Returns:
withDisplayName
public CloudPool withDisplayName(String displayName)
Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
Parameters:
Returns:
withEnableAutoScale
public CloudPool withEnableAutoScale(Boolean enableAutoScale)
Set if false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.
Parameters:
Returns:
withEnableInterNodeCommunication
public CloudPool withEnableInterNodeCommunication(Boolean enableInterNodeCommunication)
Set this imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool.
Parameters:
Returns:
withETag
public CloudPool withETag(String eTag)
Set this is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime.
Parameters:
Returns:
withId
public CloudPool withId(String id)
Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
Parameters:
Returns:
withLastModified
public CloudPool withLastModified(DateTime lastModified)
Set this is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state.
Parameters:
Returns:
withMaxTasksPerNode
public CloudPool withMaxTasksPerNode(Integer maxTasksPerNode)
Set the maxTasksPerNode value.
Parameters:
Returns:
withMetadata
public CloudPool withMetadata(List
Set the metadata value.
Parameters:
Returns:
withNetworkConfiguration
public CloudPool withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Set the networkConfiguration value.
Parameters:
Returns:
withResizeErrors
public CloudPool withResizeErrors(List
Set this property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady.
Parameters:
Returns:
withResizeTimeout
public CloudPool withResizeTimeout(Period resizeTimeout)
Set this is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes.
Parameters:
Returns:
withStartTask
public CloudPool withStartTask(StartTask startTask)
Set the startTask value.
Parameters:
Returns:
withState
public CloudPool withState(PoolState state)
Set possible values include: 'active', 'deleting'.
Parameters:
Returns:
withStateTransitionTime
public CloudPool withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value.
Parameters:
Returns:
withStats
public CloudPool withStats(PoolStatistics stats)
Set the stats value.
Parameters:
Returns:
withTargetDedicatedNodes
public CloudPool withTargetDedicatedNodes(Integer targetDedicatedNodes)
Set the targetDedicatedNodes value.
Parameters:
Returns:
withTargetLowPriorityNodes
public CloudPool withTargetLowPriorityNodes(Integer targetLowPriorityNodes)
Set the targetLowPriorityNodes value.
Parameters:
Returns:
withTaskSchedulingPolicy
public CloudPool withTaskSchedulingPolicy(TaskSchedulingPolicy taskSchedulingPolicy)
Set the taskSchedulingPolicy value.
Parameters:
Returns:
withUrl
public CloudPool withUrl(String url)
Set the url value.
Parameters:
Returns:
withUserAccounts
public CloudPool withUserAccounts(List
Set the userAccounts value.
Parameters:
Returns:
withVirtualMachineConfiguration
public CloudPool withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set this property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
Parameters:
Returns:
withVmSize
public CloudPool withVmSize(String vmSize)
Set for information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
Parameters:
Returns:
Applies to
Azure SDK for Java