Class ContainerConfiguration

java.lang.Object
com.azure.compute.batch.models.ContainerConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContainerConfiguration>

public final class ContainerConfiguration extends Object implements com.azure.json.JsonSerializable<ContainerConfiguration>
The configuration for container-enabled Pools.
  • Constructor Details

    • ContainerConfiguration

      public ContainerConfiguration(ContainerType type)
      Creates an instance of ContainerConfiguration class.
      Parameters:
      type - the type value to set.
  • Method Details

    • getType

      public ContainerType getType()
      Get the type property: The container technology to be used.
      Returns:
      the type value.
    • getContainerImageNames

      public List<String> getContainerImageNames()
      Get the containerImageNames property: The collection of container Image names. 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.
    • setContainerImageNames

      public ContainerConfiguration setContainerImageNames(List<String> containerImageNames)
      Set the containerImageNames property: The collection of container Image names. 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.
    • getContainerRegistries

      public List<ContainerRegistryReference> getContainerRegistries()
      Get the containerRegistries property: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
      Returns:
      the containerRegistries value.
    • setContainerRegistries

      public ContainerConfiguration setContainerRegistries(List<ContainerRegistryReference> containerRegistries)
      Set the containerRegistries property: Additional private registries from which containers can be pulled. 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.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ContainerConfiguration>
      Throws:
      IOException
    • fromJson

      public static ContainerConfiguration fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ContainerConfiguration from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ContainerConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ContainerConfiguration.