EnvironmentVersionProperties Class

Package:
com.azure.resourcemanager.machinelearning.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0

public final class EnvironmentVersionProperties
extends AssetBase

Environment version details.

Constructor Summary

Constructor Description
EnvironmentVersionProperties()

Creates an instance of EnvironmentVersionProperties class.

Method Summary

Modifier and Type Method and Description
AutoRebuildSetting autoRebuild()

Get the autoRebuild property: Defines if image needs to be rebuilt based on base image changes.
BuildContext build()

Get the build property: Configuration settings for Docker build context.
String condaFile()

Get the condaFile property: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
EnvironmentType environmentType()

Get the environmentType property: Environment type is either user managed or curated by the Azure ML service <see href="https://docs.<wbr>microsoft.<wbr>com/en-us/azure/machine-learning/resource-curated-environments" />.
static EnvironmentVersionProperties fromJson(JsonReader jsonReader)

Reads an instance of EnvironmentVersionProperties from the JsonReader.
String image()

Get the image property: Name of the image that will be used for the environment.
InferenceContainerProperties inferenceConfig()

Get the inferenceConfig property: Defines configuration specific to inference.
OperatingSystemType osType()

Get the osType property: The OS type of the environment.
AssetProvisioningState provisioningState()

Get the provisioningState property: Provisioning state for the environment version.
String stage()

Get the stage property: Stage in the environment lifecycle assigned to this environment.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
EnvironmentVersionProperties withAutoRebuild(AutoRebuildSetting autoRebuild)

Set the autoRebuild property: Defines if image needs to be rebuilt based on base image changes.
EnvironmentVersionProperties withBuild(BuildContext build)

Set the build property: Configuration settings for Docker build context.
EnvironmentVersionProperties withCondaFile(String condaFile)

Set the condaFile property: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
EnvironmentVersionProperties withDescription(String description)

Set the description property: The asset description text.
EnvironmentVersionProperties withImage(String image)

Set the image property: Name of the image that will be used for the environment.
EnvironmentVersionProperties withInferenceConfig(InferenceContainerProperties inferenceConfig)

Set the inferenceConfig property: Defines configuration specific to inference.
EnvironmentVersionProperties withIsAnonymous(Boolean isAnonymous)

Set the isAnonymous property: If the name version are system generated (anonymous registration).
EnvironmentVersionProperties withIsArchived(Boolean isArchived)

Set the isArchived property: Is the asset archived?.
EnvironmentVersionProperties withOsType(OperatingSystemType osType)

Set the osType property: The OS type of the environment.
EnvironmentVersionProperties withProperties(Map<String,String> properties)

Set the properties property: The asset property dictionary.
EnvironmentVersionProperties withStage(String stage)

Set the stage property: Stage in the environment lifecycle assigned to this environment.
EnvironmentVersionProperties withTags(Map<String,String> tags)

Set the tags property: Tag dictionary.

Methods inherited from AssetBase

fromJson isAnonymous isArchived toJson validate withDescription withIsAnonymous withIsArchived withProperties withTags

Methods inherited from ResourceBase

description properties tags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EnvironmentVersionProperties

public EnvironmentVersionProperties()

Creates an instance of EnvironmentVersionProperties class.

Method Details

autoRebuild

public AutoRebuildSetting autoRebuild()

Get the autoRebuild property: Defines if image needs to be rebuilt based on base image changes.

Returns:

the autoRebuild value.

build

public BuildContext build()

Get the build property: Configuration settings for Docker build context.

Returns:

the build value.

condaFile

public String condaFile()

Get the condaFile property: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. <see href="https://repo2docker.readthedocs.io/en/latest/config\_files.html\#environment-yml-install-a-conda-environment" />.

Returns:

the condaFile value.

environmentType

public EnvironmentType environmentType()

Get the environmentType property: Environment type is either user managed or curated by the Azure ML service <see href="https://docs.microsoft.com/en-us/azure/machine-learning/resource-curated-environments" />.

Returns:

the environmentType value.

fromJson

public static EnvironmentVersionProperties fromJson(JsonReader jsonReader)

Reads an instance of EnvironmentVersionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the EnvironmentVersionProperties.

image

public String image()

Get the image property: Name of the image that will be used for the environment. <seealso href="https://docs.microsoft.com/en-us/azure/machine-learning/how-to-deploy-custom-docker-image\#use-a-custom-base-image" />.

Returns:

the image value.

inferenceConfig

public InferenceContainerProperties inferenceConfig()

Get the inferenceConfig property: Defines configuration specific to inference.

Returns:

the inferenceConfig value.

osType

public OperatingSystemType osType()

Get the osType property: The OS type of the environment.

Returns:

the osType value.

provisioningState

public AssetProvisioningState provisioningState()

Get the provisioningState property: Provisioning state for the environment version.

Returns:

the provisioningState value.

stage

public String stage()

Get the stage property: Stage in the environment lifecycle assigned to this environment.

Returns:

the stage value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EnvironmentVersionProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

EnvironmentVersionProperties.validate()

withAutoRebuild

public EnvironmentVersionProperties withAutoRebuild(AutoRebuildSetting autoRebuild)

Set the autoRebuild property: Defines if image needs to be rebuilt based on base image changes.

Parameters:

autoRebuild - the autoRebuild value to set.

Returns:

the EnvironmentVersionProperties object itself.

withBuild

public EnvironmentVersionProperties withBuild(BuildContext build)

Set the build property: Configuration settings for Docker build context.

Parameters:

build - the build value to set.

Returns:

the EnvironmentVersionProperties object itself.

withCondaFile

public EnvironmentVersionProperties withCondaFile(String condaFile)

Set the condaFile property: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. <see href="https://repo2docker.readthedocs.io/en/latest/config\_files.html\#environment-yml-install-a-conda-environment" />.

Parameters:

condaFile - the condaFile value to set.

Returns:

the EnvironmentVersionProperties object itself.

withDescription

public EnvironmentVersionProperties withDescription(String description)

Set the description property: The asset description text.

Overrides:

EnvironmentVersionProperties.withDescription(String description)

Parameters:

description

withImage

public EnvironmentVersionProperties withImage(String image)

Set the image property: Name of the image that will be used for the environment. <seealso href="https://docs.microsoft.com/en-us/azure/machine-learning/how-to-deploy-custom-docker-image\#use-a-custom-base-image" />.

Parameters:

image - the image value to set.

Returns:

the EnvironmentVersionProperties object itself.

withInferenceConfig

public EnvironmentVersionProperties withInferenceConfig(InferenceContainerProperties inferenceConfig)

Set the inferenceConfig property: Defines configuration specific to inference.

Parameters:

inferenceConfig - the inferenceConfig value to set.

Returns:

the EnvironmentVersionProperties object itself.

withIsAnonymous

public EnvironmentVersionProperties withIsAnonymous(Boolean isAnonymous)

Set the isAnonymous property: If the name version are system generated (anonymous registration).

Overrides:

EnvironmentVersionProperties.withIsAnonymous(Boolean isAnonymous)

Parameters:

isAnonymous

withIsArchived

public EnvironmentVersionProperties withIsArchived(Boolean isArchived)

Set the isArchived property: Is the asset archived?.

Overrides:

EnvironmentVersionProperties.withIsArchived(Boolean isArchived)

Parameters:

isArchived

withOsType

public EnvironmentVersionProperties withOsType(OperatingSystemType osType)

Set the osType property: The OS type of the environment.

Parameters:

osType - the osType value to set.

Returns:

the EnvironmentVersionProperties object itself.

withProperties

public EnvironmentVersionProperties withProperties(Map<String,String> properties)

Set the properties property: The asset property dictionary.

Overrides:

EnvironmentVersionProperties.withProperties(Map<String,String> properties)

Parameters:

properties

withStage

public EnvironmentVersionProperties withStage(String stage)

Set the stage property: Stage in the environment lifecycle assigned to this environment.

Parameters:

stage - the stage value to set.

Returns:

the EnvironmentVersionProperties object itself.

withTags

public EnvironmentVersionProperties withTags(Map<String,String> tags)

Set the tags property: Tag dictionary. Tags can be added, removed, and updated.

Overrides:

EnvironmentVersionProperties.withTags(Map<String,String> tags)

Parameters:

tags

Applies to