azure-docs-sdk-java/docs-ref-autogen/com.azure.developer.devcent...

133 строки
9.2 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.developer.devcenter.models.EnvironmentDefinition"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition"
name: "EnvironmentDefinition"
nameWithType: "EnvironmentDefinition"
summary: "An environment definition."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **EnvironmentDefinition**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.developer.devcenter.models.EnvironmentDefinition?alt=com.azure.developer.devcenter.models.EnvironmentDefinition&text=EnvironmentDefinition\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "EnvironmentDefinition.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Environment<wbr>Definition from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static EnvironmentDefinition fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of EnvironmentDefinition from the JsonReader."
returns:
description: "An instance of EnvironmentDefinition if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
type: "<xref href=\"com.azure.developer.devcenter.models.EnvironmentDefinition?alt=com.azure.developer.devcenter.models.EnvironmentDefinition&text=EnvironmentDefinition\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getCatalogName()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getCatalogName()"
name: "getCatalogName()"
nameWithType: "EnvironmentDefinition.getCatalogName()"
summary: "Get the catalog<wbr>Name property: Name of the catalog."
syntax: "public String getCatalogName()"
desc: "Get the catalogName property: Name of the catalog."
returns:
description: "the catalogName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getDescription()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getDescription()"
name: "getDescription()"
nameWithType: "EnvironmentDefinition.getDescription()"
summary: "Get the description property: A short description of the environment definition."
syntax: "public String getDescription()"
desc: "Get the description property: A short description of the environment definition."
returns:
description: "the description value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getId()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getId()"
name: "getId()"
nameWithType: "EnvironmentDefinition.getId()"
summary: "Get the id property: The ID of the environment definition."
syntax: "public String getId()"
desc: "Get the id property: The ID of the environment definition."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getName()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getName()"
name: "getName()"
nameWithType: "EnvironmentDefinition.getName()"
summary: "Get the name property: Name of the environment definition."
syntax: "public String getName()"
desc: "Get the name property: Name of the environment definition."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getParameters()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getParameters()"
name: "getParameters()"
nameWithType: "EnvironmentDefinition.getParameters()"
summary: "Get the parameters property: Input parameters passed to an environment."
syntax: "public List<EnvironmentDefinitionParameter> getParameters()"
desc: "Get the parameters property: Input parameters passed to an environment."
returns:
description: "the parameters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.developer.devcenter.models.EnvironmentDefinitionParameter?alt=com.azure.developer.devcenter.models.EnvironmentDefinitionParameter&text=EnvironmentDefinitionParameter\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getParametersSchema()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getParametersSchema()"
name: "getParametersSchema()"
nameWithType: "EnvironmentDefinition.getParametersSchema()"
summary: "Get the parameters<wbr>Schema property: JSON schema defining the parameters object passed to an environment."
syntax: "public String getParametersSchema()"
desc: "Get the parametersSchema property: JSON schema defining the parameters object passed to an environment."
returns:
description: "the parametersSchema value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.getTemplatePath()"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.getTemplatePath()"
name: "getTemplatePath()"
nameWithType: "EnvironmentDefinition.getTemplatePath()"
summary: "Get the template<wbr>Path property: Path to the Environment Definition entrypoint file."
syntax: "public String getTemplatePath()"
desc: "Get the templatePath property: Path to the Environment Definition entrypoint file."
returns:
description: "the templatePath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.developer.devcenter.models.EnvironmentDefinition.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.developer.devcenter.models.EnvironmentDefinition.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "EnvironmentDefinition.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An environment definition."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.developer.devcenter.models.EnvironmentDefinition?alt=com.azure.developer.devcenter.models.EnvironmentDefinition&text=EnvironmentDefinition\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.developer.devcenter.models"
artifact: com.azure:azure-developer-devcenter:1.0.5