ContainerConfiguration Class

  • java.lang.Object
    • com.azure.resourcemanager.batch.models.ContainerConfiguration

Implements

public final class ContainerConfiguration
implements JsonSerializable<ContainerConfiguration>

The configuration for container-enabled pools.

Constructor Summary

Constructor Description
ContainerConfiguration()

Creates an instance of ContainerConfiguration class.

Method Summary

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

Get the containerImageNames property: This is the full image reference, as would be specified to "docker pull".

List<ContainerRegistry> containerRegistries()

Get the containerRegistries property: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

static ContainerConfiguration fromJson(JsonReader jsonReader)

Reads an instance of ContainerConfiguration from the JsonReader.

JsonWriter toJson(JsonWriter jsonWriter)
ContainerType type()

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

void validate()

Validates the instance.

ContainerConfiguration withContainerImageNames(List<String> containerImageNames)

Set the containerImageNames property: This is the full image reference, as would be specified to "docker pull".

ContainerConfiguration withContainerRegistries(List<ContainerRegistry> containerRegistries)

Set the containerRegistries property: 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 the type property: The container technology to be used.

Methods inherited from java.lang.Object

Constructor Details

ContainerConfiguration

public ContainerConfiguration()

Creates an instance of ContainerConfiguration class.

Method Details

containerImageNames

public List containerImageNames()

Get the containerImageNames property: 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 the containerRegistries property: If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

Returns:

the containerRegistries value.

fromJson

public static ContainerConfiguration fromJson(JsonReader jsonReader)

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:

IOException

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

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public ContainerType type()

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

Returns:

the type value.

validate

public void validate()

Validates the instance.

withContainerImageNames

public ContainerConfiguration withContainerImageNames(List containerImageNames)

Set the containerImageNames property: 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 the containerRegistries property: 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 the type property: The container technology to be used.

Parameters:

type - the type value to set.

Returns:

the ContainerConfiguration object itself.

Applies to