Package com.azure.developer.devcenter.models

Class EnvironmentDefinitionParameter

java.lang.Object
com.azure.developer.devcenter.models.EnvironmentDefinitionParameter
All Implemented Interfaces:
com.azure.json.JsonSerializable<EnvironmentDefinitionParameter>
public final class EnvironmentDefinitionParameter extends Object implements com.azure.json.JsonSerializable<EnvironmentDefinitionParameter>
Properties of an Environment Definition parameter.

  • Method Details

    • getId

      public String getId()
      Get the id property: Unique ID of the parameter.
      Returns:
      the id value.

    • getName

      public String getName()
      Get the name property: Display name of the parameter.
      Returns:
      the name value.

    • getDescription

      public String getDescription()
      Get the description property: Description of the parameter.
      Returns:
      the description value.

    • getDefaultValue

      public String getDefaultValue()
      Get the defaultValue property: Default value of the parameter.
      Returns:
      the defaultValue value.

    • getParameterType

      public EnvironmentDefinitionParameterType getParameterType()
      Get the parameterType property: A string of one of the basic JSON types (number, integer, array, object, boolean, string).
      Returns:
      the parameterType value.

    • isReadOnly

      public Boolean isReadOnly()
      Get the readOnly property: Whether or not this parameter is read-only. If true, default should have a value.
      Returns:
      the readOnly value.

    • isRequired

      public boolean isRequired()
      Get the required property: Whether or not this parameter is required.
      Returns:
      the required value.

    • getAllowed

      public List<String> getAllowed()
      Get the allowed property: An array of allowed values.
      Returns:
      the allowed value.

    • toJson

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

    • fromJson

      public static EnvironmentDefinitionParameter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of EnvironmentDefinitionParameter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of EnvironmentDefinitionParameter 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 EnvironmentDefinitionParameter.