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

Implements

JsonSerializable<EnvironmentDefinition>

public final class EnvironmentDefinition
implements JsonSerializable<EnvironmentDefinition>

An environment definition.

Method Summary

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

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

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

Get the description property: A short description of the environment definition.
String getId()

Get the id property: The ID of the environment definition.
String getName()

Get the name property: Name of the environment definition.
List<EnvironmentDefinitionParameter> getParameters()

Get the parameters property: Input parameters passed to an environment.
String getParametersSchema()

Get the parametersSchema property: JSON schema defining the parameters object passed to an environment.
String getTemplatePath()

Get the templatePath property: Path to the Environment Definition entrypoint file.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static EnvironmentDefinition fromJson(JsonReader jsonReader)

Reads an instance of EnvironmentDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EnvironmentDefinition 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.

getDescription

public String getDescription()

Get the description property: A short description of the environment definition.

Returns:

the description value.

getId

public String getId()

Get the id property: The ID of the environment definition.

Returns:

the id value.

getName

public String getName()

Get the name property: Name of the environment definition.

Returns:

the name value.

getParameters

public List<EnvironmentDefinitionParameter> getParameters()

Get the parameters property: Input parameters passed to an environment.

Returns:

the parameters value.

getParametersSchema

public String getParametersSchema()

Get the parametersSchema property: JSON schema defining the parameters object passed to an environment.

Returns:

the parametersSchema value.

getTemplatePath

public String getTemplatePath()

Get the templatePath property: Path to the Environment Definition entrypoint file.

Returns:

the templatePath value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to