Share via


DevBoxDefinitionProperties Class

public final class DevBoxDefinitionProperties
extends DevBoxDefinitionUpdateProperties

Properties of a Dev Box definition.

Constructor Summary

Constructor Description
DevBoxDefinitionProperties()

Creates an instance of DevBoxDefinitionProperties class.

Method Summary

Modifier and Type Method and Description
ImageReference activeImageReference()

Get the activeImageReference property: Image reference information for the currently active image (only populated during updates).

static DevBoxDefinitionProperties fromJson(JsonReader jsonReader)

Reads an instance of DevBoxDefinitionProperties from the JsonReader.

ImageValidationErrorDetails imageValidationErrorDetails()

Get the imageValidationErrorDetails property: Details for image validator error.

ImageValidationStatus imageValidationStatus()

Get the imageValidationStatus property: Validation status of the configured image.

ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the resource.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

CatalogResourceValidationStatus validationStatus()

Get the validationStatus property: Validation status for the Dev Box Definition.

DevBoxDefinitionProperties withHibernateSupport(HibernateSupport hibernateSupport)

Set the hibernateSupport property: Indicates whether Dev Boxes created with this definition are capable of hibernation.

DevBoxDefinitionProperties withImageReference(ImageReference imageReference)

Set the imageReference property: Image reference information.

DevBoxDefinitionProperties withOsStorageType(String osStorageType)

Set the osStorageType property: The storage type used for the Operating System disk of Dev Boxes created using this definition.

DevBoxDefinitionProperties withSku(Sku sku)

Set the sku property: The SKU for Dev Boxes created using this definition.

Methods inherited from DevBoxDefinitionUpdateProperties

Methods inherited from java.lang.Object

Constructor Details

DevBoxDefinitionProperties

public DevBoxDefinitionProperties()

Creates an instance of DevBoxDefinitionProperties class.

Method Details

activeImageReference

public ImageReference activeImageReference()

Get the activeImageReference property: Image reference information for the currently active image (only populated during updates).

Returns:

the activeImageReference value.

fromJson

public static DevBoxDefinitionProperties fromJson(JsonReader jsonReader)

Reads an instance of DevBoxDefinitionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DevBoxDefinitionProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the DevBoxDefinitionProperties.

imageValidationErrorDetails

public ImageValidationErrorDetails imageValidationErrorDetails()

Get the imageValidationErrorDetails property: Details for image validator error. Populated when the image validation is not successful.

Returns:

the imageValidationErrorDetails value.

imageValidationStatus

public ImageValidationStatus imageValidationStatus()

Get the imageValidationStatus property: Validation status of the configured image.

Returns:

the imageValidationStatus value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the resource.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DevBoxDefinitionProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

DevBoxDefinitionProperties.validate()

validationStatus

public CatalogResourceValidationStatus validationStatus()

Get the validationStatus property: Validation status for the Dev Box Definition.

Returns:

the validationStatus value.

withHibernateSupport

public DevBoxDefinitionProperties withHibernateSupport(HibernateSupport hibernateSupport)

Set the hibernateSupport property: Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate.

Overrides:

DevBoxDefinitionProperties.withHibernateSupport(HibernateSupport hibernateSupport)

Parameters:

hibernateSupport

withImageReference

public DevBoxDefinitionProperties withImageReference(ImageReference imageReference)

Set the imageReference property: Image reference information.

Overrides:

DevBoxDefinitionProperties.withImageReference(ImageReference imageReference)

Parameters:

imageReference

withOsStorageType

public DevBoxDefinitionProperties withOsStorageType(String osStorageType)

Set the osStorageType property: The storage type used for the Operating System disk of Dev Boxes created using this definition.

Overrides:

DevBoxDefinitionProperties.withOsStorageType(String osStorageType)

Parameters:

osStorageType

withSku

public DevBoxDefinitionProperties withSku(Sku sku)

Set the sku property: The SKU for Dev Boxes created using this definition.

Overrides:

DevBoxDefinitionProperties.withSku(Sku sku)

Parameters:

sku

Applies to