Package com.azure.developer.devcenter.models

Class DevBox

java.lang.Object
com.azure.developer.devcenter.models.DevBox
All Implemented Interfaces:
com.azure.json.JsonSerializable<DevBox>
public final class DevBox extends Object implements com.azure.json.JsonSerializable<DevBox>
A Dev Box.

  • Constructor Details

    • DevBox

      public DevBox(String devBoxName, String poolName)
      Creates an instance of DevBox class.
      Parameters:
      devBoxName - the dev box name value to set.
      poolName - the pool name value to set.

  • Method Details

    • getName

      public String getName()
      Get the name property: Display name for the Dev Box.
      Returns:
      the name value.

    • getProjectName

      public String getProjectName()
      Get the projectName property: Name of the project this Dev Box belongs to.
      Returns:
      the projectName value.

    • getPoolName

      public String getPoolName()
      Get the poolName property: The name of the Dev Box pool this machine belongs to.
      Returns:
      the poolName value.

    • getHibernateSupport

      public HibernateSupport getHibernateSupport()
      Get the hibernateSupport property: Indicates whether hibernate is enabled/disabled or unknown.
      Returns:
      the hibernateSupport value.

    • getProvisioningState

      public DevBoxProvisioningState getProvisioningState()
      Get the provisioningState property: The current provisioning state of the Dev Box.
      Returns:
      the provisioningState value.

    • getActionState

      public String getActionState()
      Get the actionState property: The current action state of the Dev Box. This is state is based on previous action performed by user.
      Returns:
      the actionState value.

    • getPowerState

      public PowerState getPowerState()
      Get the powerState property: The current power state of the Dev Box.
      Returns:
      the powerState value.

    • getUniqueId

      public String getUniqueId()
      Get the uniqueId property: A unique identifier for the Dev Box. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
      Returns:
      the uniqueId value.

    • getError

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

    • getLocation

      public String getLocation()
      Get the location property: Azure region where this Dev Box is located. This will be the same region as the Virtual Network it is attached to.
      Returns:
      the location value.

    • getOsType

      public DevBoxOsType getOsType()
      Get the osType property: The operating system type of this Dev Box.
      Returns:
      the osType value.

    • getUserId

      public String getUserId()
      Get the userId property: The AAD object id of the user this Dev Box is assigned to.
      Returns:
      the userId value.

    • getHardwareProfile

      public DevBoxHardwareProfile getHardwareProfile()
      Get the hardwareProfile property: Information about the Dev Box's hardware resources.
      Returns:
      the hardwareProfile value.

    • getStorageProfile

      public DevBoxStorageProfile getStorageProfile()
      Get the storageProfile property: Storage settings for this Dev Box.
      Returns:
      the storageProfile value.

    • getImageReference

      public DevBoxImageReference getImageReference()
      Get the imageReference property: Information about the image used for this Dev Box.
      Returns:
      the imageReference value.

    • getCreatedTime

      public OffsetDateTime getCreatedTime()
      Get the createdTime property: Creation time of this Dev Box, in RFC3339 format.
      Returns:
      the createdTime value.

    • getLocalAdministratorStatus

      public LocalAdministratorStatus getLocalAdministratorStatus()
      Get the localAdministratorStatus property: Indicates whether the owner of the Dev Box is a local administrator.
      Returns:
      the localAdministratorStatus value.

    • setLocalAdministratorStatus

      public DevBox setLocalAdministratorStatus(LocalAdministratorStatus localAdministratorStatus)
      Set the localAdministratorStatus property: Indicates whether the owner of the Dev Box is a local administrator.
      Parameters:
      localAdministratorStatus - the localAdministratorStatus value to set.
      Returns:
      the DevBox object itself.

    • toJson

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

    • fromJson

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