ContainerConfiguration Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.ContainerConfiguration

public class ContainerConfiguration

The configuration for container-enabled Pools.

Constructor Summary

Constructor Description
ContainerConfiguration()

Method Summary

Modifier and Type Method and Description
List<String> containerImageNames()

Get this is the full Image reference, as would be specified to "docker pull".
List<ContainerRegistry> containerRegistries()

Get if any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
ContainerType type()

Get possible values include: 'dockerCompatible', 'criCompatible'.
ContainerConfiguration withContainerImageNames(List<String> containerImageNames)

Set this is the full Image reference, as would be specified to "docker pull".
ContainerConfiguration withContainerRegistries(List<ContainerRegistry> containerRegistries)

Set if any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
ContainerConfiguration withType(ContainerType type)

Set possible values include: 'dockerCompatible', 'criCompatible'.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ContainerConfiguration

public ContainerConfiguration()

Method Details

containerImageNames

public List containerImageNames()

Get this is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.

Returns:

the containerImageNames value

containerRegistries

public List containerRegistries()

Get if any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

Returns:

the containerRegistries value

type

public ContainerType type()

Get possible values include: 'dockerCompatible', 'criCompatible'.

Returns:

the type value

withContainerImageNames

public ContainerConfiguration withContainerImageNames(List containerImageNames)

Set this is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.

Parameters:

containerImageNames - the containerImageNames value to set

Returns:

the ContainerConfiguration object itself.

withContainerRegistries

public ContainerConfiguration withContainerRegistries(List containerRegistries)

Set if any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

Parameters:

containerRegistries - the containerRegistries value to set

Returns:

the ContainerConfiguration object itself.

withType

public ContainerConfiguration withType(ContainerType type)

Set possible values include: 'dockerCompatible', 'criCompatible'.

Parameters:

type - the type value to set

Returns:

the ContainerConfiguration object itself.

Applies to