MultiInstanceSettings Class

Package:

com.microsoft.azure.batch.protocol.models

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.MultiInstanceSettings

public class MultiInstanceSettings

Settings which specify how to run a multi-instance task. Multi-instance tasks are commonly used to support MPI tasks.

Method Summary

Modifier and Type	Method and Description
List<ResourceFile>	commonResourceFiles() Get the difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
String	coordinationCommandLine() Get a typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.
Integer	numberOfInstances() Get if omitted, the default is 1.
MultiInstanceSettings	withCommonResourceFiles(List<ResourceFile> commonResourceFiles) Set the difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
MultiInstanceSettings	withCoordinationCommandLine(String coordinationCommandLine) Set a typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.
MultiInstanceSettings	withNumberOfInstances(Integer numberOfInstances) Set if omitted, the default is 1.

Method Details

commonResourceFiles

public List commonResourceFiles()

Get the difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

Returns:

the commonResourceFiles value

coordinationCommandLine

public String coordinationCommandLine()

Get a typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.

Returns:

the coordinationCommandLine value

numberOfInstances

public Integer numberOfInstances()

Get if omitted, the default is 1.

Returns:

the numberOfInstances value

withCommonResourceFiles

public MultiInstanceSettings withCommonResourceFiles(List commonResourceFiles)

Set the difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

Parameters:

commonResourceFiles - the commonResourceFiles value to set

Returns:

the MultiInstanceSettings object itself.

withCoordinationCommandLine

public MultiInstanceSettings withCoordinationCommandLine(String coordinationCommandLine)

Set a typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.

Parameters:

coordinationCommandLine - the coordinationCommandLine value to set

Returns:

the MultiInstanceSettings object itself.

withNumberOfInstances

public MultiInstanceSettings withNumberOfInstances(Integer numberOfInstances)

Set if omitted, the default is 1.

Parameters:

numberOfInstances - the numberOfInstances value to set

Returns:

the MultiInstanceSettings object itself.