ClusterInner Class
- java.
lang. Object - ProxyResource
- com.
microsoft. azure. management. batchai. implementation. ClusterInner
- com.
public class ClusterInner
Information about a Cluster.
Method Summary
Modifier and Type | Method and Description |
---|---|
Allocation |
allocationState()
Get allocation state of the cluster. Possible values are: steady - Indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing - Indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster. Possible values include: 'steady', 'resizing'. |
DateTime |
allocationStateTransitionTime()
Get the time at which the cluster entered its current allocation state. |
DateTime |
creationTime()
Get the time when the cluster was created. |
Integer |
currentNodeCount()
Get the number of compute nodes currently assigned to the cluster. |
List<Batch |
errors()
Get collection of errors encountered by various compute nodes during node setup. |
Node |
nodeSetup()
Get setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster. |
Node |
nodeStateCounts()
Get counts of various node states on the cluster. |
Provisioning |
provisioningState()
Get provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted. Possible values include: 'creating', 'succeeded', 'failed', 'deleting'. |
DateTime |
provisioningStateTransitionTime()
Get time when the provisioning state was changed. |
Scale |
scaleSettings()
Get scale settings of the cluster. |
Resource |
subnet()
Get virtual network subnet resource ID the cluster nodes belong to. |
User |
userAccountSettings()
Get administrator user account settings which can be used to SSH to compute nodes. |
Virtual |
virtualMachineConfiguration()
Get virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration. |
Vm |
vmPriority()
Get vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'. |
String |
vmSize()
Get the size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. |
Cluster |
withNodeSetup(NodeSetup nodeSetup)
Set setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster. |
Cluster |
withScaleSettings(ScaleSettings scaleSettings)
Set scale settings of the cluster. |
Cluster |
withSubnet(ResourceId subnet)
Set virtual network subnet resource ID the cluster nodes belong to. |
Cluster |
withUserAccountSettings(UserAccountSettings userAccountSettings)
Set administrator user account settings which can be used to SSH to compute nodes. |
Cluster |
withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration. |
Cluster |
withVmPriority(VmPriority vmPriority)
Set vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'. |
Cluster |
withVmSize(String vmSize)
Set the size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. |
Method Details
allocationState
public AllocationState allocationState()
Get allocation state of the cluster. Possible values are: steady - Indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing - Indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster. Possible values include: 'steady', 'resizing'.
Returns:
allocationStateTransitionTime
public DateTime allocationStateTransitionTime()
Get the time at which the cluster entered its current allocation state.
Returns:
creationTime
public DateTime creationTime()
Get the time when the cluster was created.
Returns:
currentNodeCount
public Integer currentNodeCount()
Get the number of compute nodes currently assigned to the cluster.
Returns:
errors
public List
Get collection of errors encountered by various compute nodes during node setup.
Returns:
nodeSetup
public NodeSetup nodeSetup()
Get setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.
Returns:
nodeStateCounts
public NodeStateCounts nodeStateCounts()
Get counts of various node states on the cluster.
Returns:
provisioningState
public ProvisioningState provisioningState()
Get provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted. Possible values include: 'creating', 'succeeded', 'failed', 'deleting'.
Returns:
provisioningStateTransitionTime
public DateTime provisioningStateTransitionTime()
Get time when the provisioning state was changed.
Returns:
scaleSettings
public ScaleSettings scaleSettings()
Get scale settings of the cluster.
Returns:
subnet
public ResourceId subnet()
Get virtual network subnet resource ID the cluster nodes belong to.
Returns:
userAccountSettings
public UserAccountSettings userAccountSettings()
Get administrator user account settings which can be used to SSH to compute nodes.
Returns:
virtualMachineConfiguration
public VirtualMachineConfiguration virtualMachineConfiguration()
Get virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.
Returns:
vmPriority
public VmPriority vmPriority()
Get vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'.
Returns:
vmSize
public String vmSize()
Get the size of the virtual machines in the cluster. All nodes in a cluster have the same VM size.
Returns:
withNodeSetup
public ClusterInner withNodeSetup(NodeSetup nodeSetup)
Set setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.
Parameters:
Returns:
withScaleSettings
public ClusterInner withScaleSettings(ScaleSettings scaleSettings)
Set scale settings of the cluster.
Parameters:
Returns:
withSubnet
public ClusterInner withSubnet(ResourceId subnet)
Set virtual network subnet resource ID the cluster nodes belong to.
Parameters:
Returns:
withUserAccountSettings
public ClusterInner withUserAccountSettings(UserAccountSettings userAccountSettings)
Set administrator user account settings which can be used to SSH to compute nodes.
Parameters:
Returns:
withVirtualMachineConfiguration
public ClusterInner withVirtualMachineConfiguration(VirtualMachineConfiguration virtualMachineConfiguration)
Set virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.
Parameters:
Returns:
withVmPriority
public ClusterInner withVmPriority(VmPriority vmPriority)
Set vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'.
Parameters:
Returns:
withVmSize
public ClusterInner withVmSize(String vmSize)
Set the size of the virtual machines in the cluster. All nodes in a cluster have the same VM size.
Parameters:
Returns:
Applies to
Azure SDK for Java