DevCenterEnvironment 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.DevCenterEnvironment

Implements

JsonSerializable<DevCenterEnvironment>

public final class DevCenterEnvironment
implements JsonSerializable<DevCenterEnvironment>

Properties of an environment.

Constructor Summary

Constructor Description
DevCenterEnvironment(String environmentName, String environmentTypeName, String catalogName, String environmentDefinitionName)

Creates an instance of DevCenterEnvironment class.

Method Summary

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

Reads an instance of DevCenterEnvironment from the JsonReader.
String getCatalogName()

Get the catalogName property: Name of the catalog.
String getEnvironmentDefinitionName()

Get the environmentDefinitionName property: Name of the environment definition.
String getEnvironmentTypeName()

Get the environmentTypeName property: Environment type.
ResponseError getError()

Get the error property: Provisioning error details.
String getName()

Get the name property: Environment name.
Map<String,Object> getParameters()

Get the parameters property: Parameters object for the environment.
EnvironmentProvisioningState getProvisioningState()

Get the provisioningState property: The provisioning state of the environment.
String getResourceGroupId()

Get the resourceGroupId property: The identifier of the resource group containing the environment's resources.
String getUserId()

Get the userId property: The AAD object id of the owner of this Environment.
DevCenterEnvironment setParameters(Map<String,Object> parameters)

Set the parameters property: Parameters object for the environment.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static DevCenterEnvironment fromJson(JsonReader jsonReader)

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:

IOException

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

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.

getEnvironmentTypeName

public String getEnvironmentTypeName()

Get the environmentTypeName property: Environment type.

Returns:

the environmentTypeName value.

getError

public ResponseError getError()

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

Returns:

the error value.

getName

public String getName()

Get the name property: Environment name.

Returns:

the name value.

getParameters

public Map<String,Object> getParameters()

Get the parameters property: Parameters object for the environment.

Returns:

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

getUserId

public String getUserId()

Get the userId property: The AAD object id of the owner of this Environment.

Returns:

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

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to