DevBox Class

Package:
com.azure.developer.devcenter.models
Maven Artifact:
com.azure:azure-developer-devcenter:1.0.14
  • java.lang.Object
    • com.azure.developer.devcenter.models.DevBox

Implements

JsonSerializable<DevBox>

public final class DevBox
implements JsonSerializable<DevBox>

A Dev Box.

Constructor Summary

Constructor Description
DevBox(String devBoxName, String poolName)

Creates an instance of DevBox class.

Method Summary

Modifier and Type Method and Description
static DevBox fromJson(JsonReader jsonReader)

Reads an instance of DevBox from the JsonReader.
String getActionState()

Get the actionState property: The current action state of the Dev Box.
OffsetDateTime getCreatedTime()

Get the createdTime property: Creation time of this Dev Box, in RFC3339 format.
ResponseError getError()

Get the error property: Provisioning or action error details.
DevBoxHardwareProfile getHardwareProfile()

Get the hardwareProfile property: Information about the Dev Box's hardware resources.
HibernateSupport getHibernateSupport()

Get the hibernateSupport property: Indicates whether hibernate is enabled/disabled or unknown.
DevBoxImageReference getImageReference()

Get the imageReference property: Information about the image used for this Dev Box.
LocalAdministratorStatus getLocalAdministratorStatus()

Get the localAdministratorStatus property: Indicates whether the owner of the Dev Box is a local administrator.
String getLocation()

Get the location property: Azure region where this Dev Box is located.
String getName()

Get the name property: Display name for the Dev Box.
DevBoxOsType getOsType()

Get the osType property: The operating system type of this Dev Box.
String getPoolName()

Get the poolName property: The name of the Dev Box pool this machine belongs to.
PowerState getPowerState()

Get the powerState property: The current power state of the Dev Box.
String getProjectName()

Get the projectName property: Name of the project this Dev Box belongs to.
DevBoxProvisioningState getProvisioningState()

Get the provisioningState property: The current provisioning state of the Dev Box.
DevBoxStorageProfile getStorageProfile()

Get the storageProfile property: Storage settings for this Dev Box.
String getUniqueId()

Get the uniqueId property: A unique identifier for the Dev Box.
String getUserId()

Get the userId property: The AAD object id of the user this Dev Box is assigned to.
DevBox setLocalAdministratorStatus(LocalAdministratorStatus localAdministratorStatus)

Set the localAdministratorStatus property: Indicates whether the owner of the Dev Box is a local administrator.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static DevBox fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

getCreatedTime

public OffsetDateTime getCreatedTime()

Get the createdTime property: Creation time of this Dev Box, in RFC3339 format.

Returns:

the createdTime value.

getError

public ResponseError getError()

Get the error property: Provisioning or action error details. Populated only for error states.

Returns:

the error value.

getHardwareProfile

public DevBoxHardwareProfile getHardwareProfile()

Get the hardwareProfile property: Information about the Dev Box's hardware resources.

Returns:

the hardwareProfile value.

getHibernateSupport

public HibernateSupport getHibernateSupport()

Get the hibernateSupport property: Indicates whether hibernate is enabled/disabled or unknown.

Returns:

the hibernateSupport value.

getImageReference

public DevBoxImageReference getImageReference()

Get the imageReference property: Information about the image used for this Dev Box.

Returns:

the imageReference 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.

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.

getName

public String getName()

Get the name property: Display name for the Dev Box.

Returns:

the name value.

getOsType

public DevBoxOsType getOsType()

Get the osType property: The operating system type of this Dev Box.

Returns:

the osType value.

getPoolName

public String getPoolName()

Get the poolName property: The name of the Dev Box pool this machine belongs to.

Returns:

the poolName value.

getPowerState

public PowerState getPowerState()

Get the powerState property: The current power state of the Dev Box.

Returns:

the powerState value.

getProjectName

public String getProjectName()

Get the projectName property: Name of the project this Dev Box belongs to.

Returns:

the projectName value.

getProvisioningState

public DevBoxProvisioningState getProvisioningState()

Get the provisioningState property: The current provisioning state of the Dev Box.

Returns:

the provisioningState value.

getStorageProfile

public DevBoxStorageProfile getStorageProfile()

Get the storageProfile property: Storage settings for this Dev Box.

Returns:

the storageProfile 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.

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.

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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to