Share via


BatchContainerConfiguration Class

  • java.lang.Object
    • com.azure.compute.batch.models.BatchContainerConfiguration

Implements

public final class BatchContainerConfiguration
implements JsonSerializable<BatchContainerConfiguration>

The configuration for container-enabled Pools.

Constructor Summary

Constructor Description
BatchContainerConfiguration(ContainerType type)

Creates an instance of BatchContainerConfiguration class.

Method Summary

Modifier and Type Method and Description
static BatchContainerConfiguration fromJson(JsonReader jsonReader)

Reads an instance of BatchContainerConfiguration from the JsonReader.

List<String> getContainerImageNames()

Get the containerImageNames property: The collection of container Image names.

List<ContainerRegistryReference> getContainerRegistries()

Get the containerRegistries property: Additional private registries from which containers can be pulled.

ContainerType getType()

Get the type property: The container technology to be used.

BatchContainerConfiguration setContainerImageNames(List<String> containerImageNames)

Set the containerImageNames property: The collection of container Image names.

BatchContainerConfiguration setContainerRegistries(List<ContainerRegistryReference> containerRegistries)

Set the containerRegistries property: Additional private registries from which containers can be pulled.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

BatchContainerConfiguration

public BatchContainerConfiguration(ContainerType type)

Creates an instance of BatchContainerConfiguration class.

Parameters:

type - the type value to set.

Method Details

fromJson

public static BatchContainerConfiguration fromJson(JsonReader jsonReader)

Reads an instance of BatchContainerConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchContainerConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

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.

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.

getType

public ContainerType getType()

Get the type property: The container technology to be used.

Returns:

the type value.

setContainerImageNames

public BatchContainerConfiguration 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 BatchContainerConfiguration object itself.

setContainerRegistries

public BatchContainerConfiguration 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 BatchContainerConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to