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

Implements

JsonSerializable<EnvironmentDefinitionParameter>

public final class EnvironmentDefinitionParameter
implements JsonSerializable<EnvironmentDefinitionParameter>

Properties of an Environment Definition parameter.

Method Summary

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

Reads an instance of EnvironmentDefinitionParameter from the JsonReader.
List<String> getAllowed()

Get the allowed property: An array of allowed values.
String getDefaultValue()

Get the defaultValue property: Default value of the parameter.
String getDescription()

Get the description property: Description of the parameter.
String getId()

Get the id property: Unique ID of the parameter.
String getName()

Get the name property: Display name of the parameter.
EnvironmentDefinitionParameterType getParameterType()

Get the parameterType property: A string of one of the basic JSON types (number, integer, array, object, boolean, string).
Boolean isReadOnly()

Get the readOnly property: Whether or not this parameter is read-only.
boolean isRequired()

Get the required property: Whether or not this parameter is required.
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 EnvironmentDefinitionParameter fromJson(JsonReader jsonReader)

Reads an instance of EnvironmentDefinitionParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAllowed

public List<String> getAllowed()

Get the allowed property: An array of allowed values.

Returns:

the allowed value.

getDefaultValue

public String getDefaultValue()

Get the defaultValue property: Default value of the parameter.

Returns:

the defaultValue value.

getDescription

public String getDescription()

Get the description property: Description of the parameter.

Returns:

the description value.

getId

public String getId()

Get the id property: Unique ID of the parameter.

Returns:

the id value.

getName

public String getName()

Get the name property: Display name of the parameter.

Returns:

the name value.

getParameterType

public EnvironmentDefinitionParameterType getParameterType()

Get the parameterType property: A string of one of the basic JSON types (number, integer, array, object, boolean, string).

Returns:

the parameterType value.

isReadOnly

public Boolean isReadOnly()

Get the readOnly property: Whether or not this parameter is read-only. If true, default should have a value.

Returns:

the readOnly value.

isRequired

public boolean isRequired()

Get the required property: Whether or not this parameter is required.

Returns:

the required value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to