com.microsoft.azure.management.batchai

Class AutoScaleSettings

java.lang.Object

com.microsoft.azure.management.batchai.AutoScaleSettings

public class AutoScaleSettings
extends Object

Auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster.

Constructor Summary

Constructors

Constructor and Description
AutoScaleSettings()

Method Summary

Modifier and Type	Method and Description
Integer	initialNodeCount() Get the number of compute nodes to allocate on cluster creation.
int	maximumNodeCount() Get the maximum number of compute nodes the cluster can have.
int	minimumNodeCount() Get the minimum number of compute nodes the Batch AI service will try to allocate for the cluster.
AutoScaleSettings	withInitialNodeCount(Integer initialNodeCount) Set the number of compute nodes to allocate on cluster creation.
AutoScaleSettings	withMaximumNodeCount(int maximumNodeCount) Set the maximum number of compute nodes the cluster can have.
AutoScaleSettings	withMinimumNodeCount(int minimumNodeCount) Set the minimum number of compute nodes the Batch AI service will try to allocate for the cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoScaleSettings

public AutoScaleSettings()

Method Detail

minimumNodeCount

public int minimumNodeCount()

Get the minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request.

Returns:

the minimumNodeCount value

withMinimumNodeCount

public AutoScaleSettings withMinimumNodeCount(int minimumNodeCount)

Set the minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request.

Parameters:

minimumNodeCount - the minimumNodeCount value to set

Returns:

the AutoScaleSettings object itself.

maximumNodeCount

public int maximumNodeCount()

Get the maximum number of compute nodes the cluster can have.

Returns:

the maximumNodeCount value

withMaximumNodeCount

public AutoScaleSettings withMaximumNodeCount(int maximumNodeCount)

Set the maximum number of compute nodes the cluster can have.

Parameters:

maximumNodeCount - the maximumNodeCount value to set

Returns:

the AutoScaleSettings object itself.

initialNodeCount

public Integer initialNodeCount()

Get the number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.

Returns:

the initialNodeCount value

withInitialNodeCount

public AutoScaleSettings withInitialNodeCount(Integer initialNodeCount)

Set the number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.

Parameters:

initialNodeCount - the initialNodeCount value to set

Returns:

the AutoScaleSettings object itself.