Package com.azure.developer.devcenter.models

Class DevCenterEnvironment

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

  • Constructor Details

    • DevCenterEnvironment

      public DevCenterEnvironment(String environmentName, String environmentTypeName, String catalogName, String environmentDefinitionName)
      Creates an instance of DevCenterEnvironment class.
      Parameters:
      environmentName - the environmentName value to set.
      environmentTypeName - the environmentTypeName value to set.
      catalogName - the catalogName value to set.
      environmentDefinitionName - the environmentDefinitionName value to set.

  • Method Details

    • getParameters

      public Map<String,Object> getParameters()
      Get the parameters property: Parameters object for the environment.
      Returns:
      the parameters value.

    • setParameters

      public DevCenterEnvironment setParameters(Map<String,Object> parameters)
      Set the parameters property: Parameters object for the environment.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the DevCenterEnvironment object itself.

    • getName

      public String getName()
      Get the name property: Environment name.
      Returns:
      the name value.

    • getEnvironmentTypeName

      public String getEnvironmentTypeName()
      Get the environmentTypeName property: Environment type.
      Returns:
      the environmentTypeName value.

    • getUserId

      public String getUserId()
      Get the userId property: The AAD object id of the owner of this Environment.
      Returns:
      the userId value.

    • getProvisioningState

      public EnvironmentProvisioningState getProvisioningState()
      Get the provisioningState property: The provisioning state of the environment.
      Returns:
      the provisioningState value.

    • getResourceGroupId

      public String getResourceGroupId()
      Get the resourceGroupId property: The identifier of the resource group containing the environment's resources.
      Returns:
      the resourceGroupId value.

    • getCatalogName

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

    • getEnvironmentDefinitionName

      public String getEnvironmentDefinitionName()
      Get the environmentDefinitionName property: Name of the environment definition.
      Returns:
      the environmentDefinitionName value.

    • getError

      public com.azure.core.models.ResponseError getError()
      Get the error property: Provisioning error details. Populated only for error states.
      Returns:
      the error value.

    • toJson

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

    • fromJson

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