MultiInstanceSettings Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

• java.lang.Object
• • com.azure.compute.batch.models.MultiInstanceSettings

Implements

JsonSerializable<MultiInstanceSettings>

public final class MultiInstanceSettings
implements JsonSerializable<MultiInstanceSettings>

Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.

Constructor Summary

Constructor	Description
MultiInstanceSettings(String coordinationCommandLine)	Creates an instance of MultiInstanceSettings class.

Method Summary

Modifier and Type	Method and Description
static MultiInstanceSettings	fromJson(JsonReader jsonReader) Reads an instance of MultiInstanceSettings from the JsonReader.
List<ResourceFile>	getCommonResourceFiles() Get the commonResourceFiles property: A list of files that the Batch service will download before running the coordination command line.
String	getCoordinationCommandLine() Get the coordinationCommandLine property: The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command.
Integer	getNumberOfInstances() Get the numberOfInstances property: The number of Compute Nodes required by the Task.
MultiInstanceSettings	setCommonResourceFiles(List<ResourceFile> commonResourceFiles) Set the commonResourceFiles property: A list of files that the Batch service will download before running the coordination command line.
MultiInstanceSettings	setNumberOfInstances(Integer numberOfInstances) Set the numberOfInstances property: The number of Compute Nodes required by the Task.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MultiInstanceSettings

public MultiInstanceSettings(String coordinationCommandLine)

Creates an instance of MultiInstanceSettings class.

Parameters:

coordinationCommandLine - the coordinationCommandLine value to set.

Method Details

fromJson

public static MultiInstanceSettings fromJson(JsonReader jsonReader)

Reads an instance of MultiInstanceSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MultiInstanceSettings if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getCommonResourceFiles

public List<ResourceFile> getCommonResourceFiles()

Get the commonResourceFiles property: A list of files that the Batch service will download before running the coordination command line. 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.

getCoordinationCommandLine

public String getCoordinationCommandLine()

Get the coordinationCommandLine property: The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command. 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.

getNumberOfInstances

public Integer getNumberOfInstances()

Get the numberOfInstances property: The number of Compute Nodes required by the Task. If omitted, the default is 1.

Returns:

the numberOfInstances value.

setCommonResourceFiles

public MultiInstanceSettings setCommonResourceFiles(List<ResourceFile> commonResourceFiles)

Set the commonResourceFiles property: A list of files that the Batch service will download before running the coordination command line. 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.

setNumberOfInstances

public MultiInstanceSettings setNumberOfInstances(Integer numberOfInstances)

Set the numberOfInstances property: The number of Compute Nodes required by the Task. If omitted, the default is 1.

Parameters:

numberOfInstances - the numberOfInstances value to set.

Returns:

the MultiInstanceSettings object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException