TaskContainerSettings Class
- java.
lang. Object - com.
microsoft. azure. management. batch. TaskContainerSettings
- com.
public class TaskContainerSettings
The container settings for a task.
Method Summary
Modifier and Type | Method and Description |
---|---|
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". If no tag is provided as part of the image name, the tag ":latest" is used as a default. |
Container |
registry()
Get this setting can be omitted if was already provided at pool creation. |
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". If no tag is provided as part of the image name, the tag ":latest" is used as a default. |
Task |
withRegistry(ContainerRegistry registry)
Set this setting can be omitted if was already provided at pool creation. |
Task |
withWorkingDirectory(ContainerWorkingDirectory workingDirectory)
Set possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'. |
Container |
workingDirectory()
Get possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'. |
Method Details
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:
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 possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'.
Parameters:
Returns:
workingDirectory
public ContainerWorkingDirectory workingDirectory()
Get possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'.
Returns: