ClusterInner Class

Package:

com.microsoft.azure.management.batchai.implementation

• java.lang.Object
• • ProxyResource
  • • com.microsoft.azure.management.batchai.implementation.ClusterInner

public class ClusterInner

Information about a Cluster.

Method Summary

Modifier and Type	Method and Description
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'.
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<BatchAIError>	errors() Get collection of errors encountered by various compute nodes during node setup.
NodeSetup	nodeSetup() Get setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.
NodeStateCounts	nodeStateCounts() Get counts of various node states on the cluster.
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'.
DateTime	provisioningStateTransitionTime() Get time when the provisioning state was changed.
ScaleSettings	scaleSettings() Get scale settings of the cluster.
ResourceId	subnet() Get virtual network subnet resource ID the cluster nodes belong to.
UserAccountSettings	userAccountSettings() Get administrator user account settings which can be used to SSH to compute nodes.
VirtualMachineConfiguration	virtualMachineConfiguration() Get virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.
VmPriority	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.
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.
ClusterInner	withScaleSettings(ScaleSettings scaleSettings) Set scale settings of the cluster.
ClusterInner	withSubnet(ResourceId subnet) Set virtual network subnet resource ID the cluster nodes belong to.
ClusterInner	withUserAccountSettings(UserAccountSettings userAccountSettings) Set administrator user account settings which can be used to SSH to compute nodes.
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.
ClusterInner	withVmPriority(VmPriority vmPriority) Set vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'.
ClusterInner	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:

the allocationState value

allocationStateTransitionTime

public DateTime allocationStateTransitionTime()

Get the time at which the cluster entered its current allocation state.

Returns:

the allocationStateTransitionTime value

creationTime

public DateTime creationTime()

Get the time when the cluster was created.

Returns:

the creationTime value

currentNodeCount

public Integer currentNodeCount()

Get the number of compute nodes currently assigned to the cluster.

Returns:

the currentNodeCount value

errors

public List errors()

Get collection of errors encountered by various compute nodes during node setup.

Returns:

the errors value

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:

the nodeSetup value

nodeStateCounts

public NodeStateCounts nodeStateCounts()

Get counts of various node states on the cluster.

Returns:

the nodeStateCounts value

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:

the provisioningState value

provisioningStateTransitionTime

public DateTime provisioningStateTransitionTime()

Get time when the provisioning state was changed.

Returns:

the provisioningStateTransitionTime value

scaleSettings

public ScaleSettings scaleSettings()

Get scale settings of the cluster.

Returns:

the scaleSettings value

subnet

public ResourceId subnet()

Get virtual network subnet resource ID the cluster nodes belong to.

Returns:

the subnet value

userAccountSettings

public UserAccountSettings userAccountSettings()

Get administrator user account settings which can be used to SSH to compute nodes.

Returns:

the userAccountSettings value

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:

the virtualMachineConfiguration value

vmPriority

public VmPriority vmPriority()

Get vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'.

Returns:

the vmPriority value

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:

the vmSize value

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:

nodeSetup - the nodeSetup value to set

Returns:

the ClusterInner object itself.

withScaleSettings

public ClusterInner withScaleSettings(ScaleSettings scaleSettings)

Set scale settings of the cluster.

Parameters:

scaleSettings - the scaleSettings value to set

Returns:

the ClusterInner object itself.

withSubnet

public ClusterInner withSubnet(ResourceId subnet)

Set virtual network subnet resource ID the cluster nodes belong to.

Parameters:

subnet - the subnet value to set

Returns:

the ClusterInner object itself.

withUserAccountSettings

public ClusterInner withUserAccountSettings(UserAccountSettings userAccountSettings)

Set administrator user account settings which can be used to SSH to compute nodes.

Parameters:

userAccountSettings - the userAccountSettings value to set

Returns:

the ClusterInner object itself.

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:

virtualMachineConfiguration - the virtualMachineConfiguration value to set

Returns:

the ClusterInner object itself.

withVmPriority

public ClusterInner withVmPriority(VmPriority vmPriority)

Set vM priority of cluster nodes. Possible values include: 'dedicated', 'lowpriority'.

Parameters:

vmPriority - the vmPriority value to set

Returns:

the ClusterInner object itself.

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:

vmSize - the vmSize value to set

Returns:

the ClusterInner object itself.