Package com.azure.developer.devcenter.models

Class EnvironmentDefinition

java.lang.Object
com.azure.developer.devcenter.models.EnvironmentDefinition
All Implemented Interfaces:
com.azure.json.JsonSerializable<EnvironmentDefinition>
public final class EnvironmentDefinition extends Object implements com.azure.json.JsonSerializable<EnvironmentDefinition>
An environment definition.

  • Method Details

    • getId

      public String getId()
      Get the id property: The ID of the environment definition.
      Returns:
      the id value.

    • getName

      public String getName()
      Get the name property: Name of the environment definition.
      Returns:
      the name value.

    • getCatalogName

      public String getCatalogName()
      Get the catalogName property: Name of the catalog.
      Returns:
      the catalogName value.

    • getDescription

      public String getDescription()
      Get the description property: A short description of the environment definition.
      Returns:
      the description value.

    • getParameters

      public List<EnvironmentDefinitionParameter> getParameters()
      Get the parameters property: Input parameters passed to an environment.
      Returns:
      the parameters value.

    • getParametersSchema

      public String getParametersSchema()
      Get the parametersSchema property: JSON schema defining the parameters object passed to an environment.
      Returns:
      the parametersSchema value.

    • getTemplatePath

      public String getTemplatePath()
      Get the templatePath property: Path to the Environment Definition entrypoint file.
      Returns:
      the templatePath value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<EnvironmentDefinition>
      Throws:
      IOException

    • fromJson

      public static EnvironmentDefinition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of EnvironmentDefinition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of EnvironmentDefinition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the EnvironmentDefinition.