TaskContainerSettings Class

Package:

com.microsoft.azure.batch.protocol.models

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

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

public class TaskContainerSettings

The container settings for a Task.

Constructor Summary

Constructor	Description
TaskContainerSettings()

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".
ContainerRegistry	registry() Get this setting can be omitted if was already provided at Pool creation.
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.
TaskContainerSettings	withImageName(String imageName) Set this is the full Image reference, as would be specified to "docker pull".
TaskContainerSettings	withRegistry(ContainerRegistry registry) Set this setting can be omitted if was already provided at Pool creation.
TaskContainerSettings	withWorkingDirectory(ContainerWorkingDirectory workingDirectory) Set the default is 'taskWorkingDirectory'.
ContainerWorkingDirectory	workingDirectory() Get the default is 'taskWorkingDirectory'.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TaskContainerSettings

public TaskContainerSettings()

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:

the containerRunOptions value

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:

the imageName value

registry

public ContainerRegistry registry()

Get this setting can be omitted if was already provided at Pool creation.

Returns:

the registry value

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:

containerRunOptions - the containerRunOptions value to set

Returns:

the TaskContainerSettings object itself.

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:

imageName - the imageName value to set

Returns:

the TaskContainerSettings object itself.

withRegistry

public TaskContainerSettings withRegistry(ContainerRegistry registry)

Set this setting can be omitted if was already provided at Pool creation.

Parameters:

registry - the registry value to set

Returns:

the TaskContainerSettings object itself.

withWorkingDirectory

public TaskContainerSettings withWorkingDirectory(ContainerWorkingDirectory workingDirectory)

Set the default is 'taskWorkingDirectory'. Possible values include: 'taskWorkingDirectory', 'containerImageDefault'.

Parameters:

workingDirectory - the workingDirectory value to set

Returns:

the TaskContainerSettings object itself.

workingDirectory

public ContainerWorkingDirectory workingDirectory()

Get the default is 'taskWorkingDirectory'. Possible values include: 'taskWorkingDirectory', 'containerImageDefault'.

Returns:

the workingDirectory value