Class EnvironmentVersionProperties

All Implemented Interfaces:
com.azure.json.JsonSerializable<ResourceBase>

public final class EnvironmentVersionProperties extends AssetBase
Environment version details.
  • Constructor Details

    • EnvironmentVersionProperties

      public EnvironmentVersionProperties()
      Creates an instance of EnvironmentVersionProperties class.
  • Method Details

    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • build

      public BuildContext build()
      Get the build property: Configuration settings for Docker build context.
      Returns:
      the build value.
    • 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.
    • osType

      public OperatingSystemType osType()
      Get the osType property: The OS type of the environment.
      Returns:
      the osType value.
    • withOsType

      Set the osType property: The OS type of the environment.
      Parameters:
      osType - the osType value to set.
      Returns:
      the EnvironmentVersionProperties object itself.
    • inferenceConfig

      public InferenceContainerProperties inferenceConfig()
      Get the inferenceConfig property: Defines configuration specific to inference.
      Returns:
      the inferenceConfig value.
    • 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.
    • autoRebuild

      public AutoRebuildSetting autoRebuild()
      Get the autoRebuild property: Defines if image needs to be rebuilt based on base image changes.
      Returns:
      the autoRebuild value.
    • 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.
    • 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.
    • 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.
    • withIsArchived

      public EnvironmentVersionProperties withIsArchived(Boolean isArchived)
      Set the isArchived property: Is the asset archived?.
      Overrides:
      withIsArchived in class AssetBase
      Parameters:
      isArchived - the isArchived value to set.
      Returns:
      the AssetBase object itself.
    • withIsAnonymous

      public EnvironmentVersionProperties withIsAnonymous(Boolean isAnonymous)
      Set the isAnonymous property: If the name version are system generated (anonymous registration).
      Overrides:
      withIsAnonymous in class AssetBase
      Parameters:
      isAnonymous - the isAnonymous value to set.
      Returns:
      the AssetBase object itself.
    • withDescription

      public EnvironmentVersionProperties withDescription(String description)
      Set the description property: The asset description text.
      Overrides:
      withDescription in class AssetBase
      Parameters:
      description - the description value to set.
      Returns:
      the ResourceBase object itself.
    • withTags

      public EnvironmentVersionProperties withTags(Map<String,String> tags)
      Set the tags property: Tag dictionary. Tags can be added, removed, and updated.
      Overrides:
      withTags in class AssetBase
      Parameters:
      tags - the tags value to set.
      Returns:
      the ResourceBase object itself.
    • withProperties

      public EnvironmentVersionProperties withProperties(Map<String,String> properties)
      Set the properties property: The asset property dictionary.
      Overrides:
      withProperties in class AssetBase
      Parameters:
      properties - the properties value to set.
      Returns:
      the ResourceBase object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class AssetBase
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.
    • toJson

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

      public static EnvironmentVersionProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.