TaskContainerSettings Class

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

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.
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". If no tag is provided as part of the image name, the tag ":latest" is used as a default.
TaskContainerSettings withRegistry(ContainerRegistry registry)

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

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.

Applies to