Share via


Container Class

  • java.lang.Object
    • com.azure.resourcemanager.containerinstance.models.Container

Implements

public final class Container
implements JsonSerializable<Container>

A container instance.

Constructor Summary

Constructor Description
Container()

Creates an instance of Container class.

Method Summary

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

Get the command property: The commands to execute within the container instance in exec form.

List<EnvironmentVariable> environmentVariables()

Get the environmentVariables property: The environment variables to set in the container instance.

static Container fromJson(JsonReader jsonReader)

Reads an instance of Container from the JsonReader.

String image()

Get the image property: The name of the image used to create the container instance.

ContainerPropertiesInstanceView instanceView()

Get the instanceView property: The instance view of the container instance.

ContainerProbe livenessProbe()

Get the livenessProbe property: The liveness probe.

String name()

Get the name property: The user-provided name of the container instance.

List<ContainerPort> ports()

Get the ports property: The exposed ports on the container instance.

ContainerProbe readinessProbe()

Get the readinessProbe property: The readiness probe.

ResourceRequirements resources()

Get the resources property: The resource requirements of the container instance.

SecurityContextDefinition securityContext()

Get the securityContext property: The container security properties.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

List<VolumeMount> volumeMounts()

Get the volumeMounts property: The volume mounts available to the container instance.

Container withCommand(List<String> command)

Set the command property: The commands to execute within the container instance in exec form.

Container withEnvironmentVariables(List<EnvironmentVariable> environmentVariables)

Set the environmentVariables property: The environment variables to set in the container instance.

Container withImage(String image)

Set the image property: The name of the image used to create the container instance.

Container withLivenessProbe(ContainerProbe livenessProbe)

Set the livenessProbe property: The liveness probe.

Container withName(String name)

Set the name property: The user-provided name of the container instance.

Container withPorts(List<ContainerPort> ports)

Set the ports property: The exposed ports on the container instance.

Container withReadinessProbe(ContainerProbe readinessProbe)

Set the readinessProbe property: The readiness probe.

Container withResources(ResourceRequirements resources)

Set the resources property: The resource requirements of the container instance.

Container withSecurityContext(SecurityContextDefinition securityContext)

Set the securityContext property: The container security properties.

Container withVolumeMounts(List<VolumeMount> volumeMounts)

Set the volumeMounts property: The volume mounts available to the container instance.

Methods inherited from java.lang.Object

Constructor Details

Container

public Container()

Creates an instance of Container class.

Method Details

command

public List<String> command()

Get the command property: The commands to execute within the container instance in exec form.

Returns:

the command value.

environmentVariables

public List<EnvironmentVariable> environmentVariables()

Get the environmentVariables property: The environment variables to set in the container instance.

Returns:

the environmentVariables value.

fromJson

public static Container fromJson(JsonReader jsonReader)

Reads an instance of Container from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Container 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.

image

public String image()

Get the image property: The name of the image used to create the container instance.

Returns:

the image value.

instanceView

public ContainerPropertiesInstanceView instanceView()

Get the instanceView property: The instance view of the container instance. Only valid in response.

Returns:

the instanceView value.

livenessProbe

public ContainerProbe livenessProbe()

Get the livenessProbe property: The liveness probe.

Returns:

the livenessProbe value.

name

public String name()

Get the name property: The user-provided name of the container instance.

Returns:

the name value.

ports

public List<ContainerPort> ports()

Get the ports property: The exposed ports on the container instance.

Returns:

the ports value.

readinessProbe

public ContainerProbe readinessProbe()

Get the readinessProbe property: The readiness probe.

Returns:

the readinessProbe value.

resources

public ResourceRequirements resources()

Get the resources property: The resource requirements of the container instance.

Returns:

the resources value.

securityContext

public SecurityContextDefinition securityContext()

Get the securityContext property: The container security properties.

Returns:

the securityContext value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

volumeMounts

public List<VolumeMount> volumeMounts()

Get the volumeMounts property: The volume mounts available to the container instance.

Returns:

the volumeMounts value.

withCommand

public Container withCommand(List<String> command)

Set the command property: The commands to execute within the container instance in exec form.

Parameters:

command - the command value to set.

Returns:

the Container object itself.

withEnvironmentVariables

public Container withEnvironmentVariables(List<EnvironmentVariable> environmentVariables)

Set the environmentVariables property: The environment variables to set in the container instance.

Parameters:

environmentVariables - the environmentVariables value to set.

Returns:

the Container object itself.

withImage

public Container withImage(String image)

Set the image property: The name of the image used to create the container instance.

Parameters:

image - the image value to set.

Returns:

the Container object itself.

withLivenessProbe

public Container withLivenessProbe(ContainerProbe livenessProbe)

Set the livenessProbe property: The liveness probe.

Parameters:

livenessProbe - the livenessProbe value to set.

Returns:

the Container object itself.

withName

public Container withName(String name)

Set the name property: The user-provided name of the container instance.

Parameters:

name - the name value to set.

Returns:

the Container object itself.

withPorts

public Container withPorts(List<ContainerPort> ports)

Set the ports property: The exposed ports on the container instance.

Parameters:

ports - the ports value to set.

Returns:

the Container object itself.

withReadinessProbe

public Container withReadinessProbe(ContainerProbe readinessProbe)

Set the readinessProbe property: The readiness probe.

Parameters:

readinessProbe - the readinessProbe value to set.

Returns:

the Container object itself.

withResources

public Container withResources(ResourceRequirements resources)

Set the resources property: The resource requirements of the container instance.

Parameters:

resources - the resources value to set.

Returns:

the Container object itself.

withSecurityContext

public Container withSecurityContext(SecurityContextDefinition securityContext)

Set the securityContext property: The container security properties.

Parameters:

securityContext - the securityContext value to set.

Returns:

the Container object itself.

withVolumeMounts

public Container withVolumeMounts(List<VolumeMount> volumeMounts)

Set the volumeMounts property: The volume mounts available to the container instance.

Parameters:

volumeMounts - the volumeMounts value to set.

Returns:

the Container object itself.

Applies to