NodeSetup Class

  • java.lang.Object
    • com.microsoft.azure.management.batchai.NodeSetup

public class NodeSetup

Node setup settings.

Method Summary

Modifier and Type Method and Description
MountVolumes mountVolumes()

Get mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.

PerformanceCountersSettings performanceCountersSettings()

Get settings for performance counters collecting and uploading.

SetupTask setupTask()

Get setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.

NodeSetup withMountVolumes(MountVolumes mountVolumes)

Set mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.

NodeSetup withPerformanceCountersSettings(PerformanceCountersSettings performanceCountersSettings)

Set settings for performance counters collecting and uploading.

NodeSetup withSetupTask(SetupTask setupTask)

Set setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.

Method Details

mountVolumes

public MountVolumes mountVolumes()

Get mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.

Returns:

the mountVolumes value

performanceCountersSettings

public PerformanceCountersSettings performanceCountersSettings()

Get settings for performance counters collecting and uploading.

Returns:

the performanceCountersSettings value

setupTask

public SetupTask setupTask()

Get setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.

Returns:

the setupTask value

withMountVolumes

public NodeSetup withMountVolumes(MountVolumes mountVolumes)

Set mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.

Parameters:

mountVolumes - the mountVolumes value to set

Returns:

the NodeSetup object itself.

withPerformanceCountersSettings

public NodeSetup withPerformanceCountersSettings(PerformanceCountersSettings performanceCountersSettings)

Set settings for performance counters collecting and uploading.

Parameters:

performanceCountersSettings - the performanceCountersSettings value to set

Returns:

the NodeSetup object itself.

withSetupTask

public NodeSetup withSetupTask(SetupTask setupTask)

Set setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.

Parameters:

setupTask - the setupTask value to set

Returns:

the NodeSetup object itself.

Applies to