TaskContainerSettings Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. TaskContainerSettings
- com.
public class TaskContainerSettings
The container settings for a Task.
Constructor Summary
Constructor | Description | |
---|---|---|
TaskContainerSettings() |
Method Summary
Modifier and Type | Method and Description |
---|---|
List<Container |
containerHostBatchBindMounts()
Get if this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). |
String |
containerRunOptions()
Get these additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. |
String |
imageName()
Get this is the full Image reference, as would be specified to "docker pull". |
Container |
registry()
Get this setting can be omitted if was already provided at Pool creation. |
Task |
withContainerHostBatchBindMounts(List<ContainerHostBatchBindMountEntry> containerHostBatchBindMounts)
Set if this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). |
Task |
withContainerRunOptions(String containerRunOptions)
Set these additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. |
Task |
withImageName(String imageName)
Set this is the full Image reference, as would be specified to "docker pull". |
Task |
withRegistry(ContainerRegistry registry)
Set this setting can be omitted if was already provided at Pool creation. |
Task |
withWorkingDirectory(ContainerWorkingDirectory workingDirectory)
Set the default is 'task |
Container |
workingDirectory()
Get the default is 'task |
Methods inherited from java.lang.Object
Constructor Details
TaskContainerSettings
public TaskContainerSettings()
Method Details
containerHostBatchBindMounts
public List
Get if this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
Returns:
containerRunOptions
public String containerRunOptions()
Get these additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
Returns:
imageName
public String imageName()
Get this is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default.
Returns:
registry
public ContainerRegistry registry()
Get this setting can be omitted if was already provided at Pool creation.
Returns:
withContainerHostBatchBindMounts
public TaskContainerSettings withContainerHostBatchBindMounts(List
Set if this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.
Parameters:
Returns:
withContainerRunOptions
public TaskContainerSettings withContainerRunOptions(String containerRunOptions)
Set these additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
Parameters:
Returns:
withImageName
public TaskContainerSettings withImageName(String imageName)
Set this is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default.
Parameters:
Returns:
withRegistry
public TaskContainerSettings withRegistry(ContainerRegistry registry)
Set this setting can be omitted if was already provided at Pool creation.
Parameters:
Returns:
withWorkingDirectory
public TaskContainerSettings withWorkingDirectory(ContainerWorkingDirectory workingDirectory)
Set the default is 'taskWorkingDirectory'. Possible values include: 'taskWorkingDirectory', 'containerImageDefault'.
Parameters:
Returns:
workingDirectory
public ContainerWorkingDirectory workingDirectory()
Get the default is 'taskWorkingDirectory'. Possible values include: 'taskWorkingDirectory', 'containerImageDefault'.
Returns:
Applies to
Azure SDK for Java