azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.r...

208 строки
14 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.resources.models.Alias"
fullName: "com.azure.resourcemanager.resources.models.Alias"
name: "Alias"
nameWithType: "Alias"
summary: "The alias type."
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 **Alias**</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.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.resources.models.Alias.Alias()"
fullName: "com.azure.resourcemanager.resources.models.Alias.Alias()"
name: "Alias()"
nameWithType: "Alias.Alias()"
summary: "Creates an instance of Alias class."
syntax: "public Alias()"
desc: "Creates an instance of Alias class."
methods:
- uid: "com.azure.resourcemanager.resources.models.Alias.defaultMetadata()"
fullName: "com.azure.resourcemanager.resources.models.Alias.defaultMetadata()"
name: "defaultMetadata()"
nameWithType: "Alias.defaultMetadata()"
summary: "Get the default<wbr>Metadata property: The default alias path metadata."
syntax: "public AliasPathMetadata defaultMetadata()"
desc: "Get the defaultMetadata property: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata."
returns:
description: "the defaultMetadata value."
type: "<xref href=\"com.azure.resourcemanager.resources.models.AliasPathMetadata?alt=com.azure.resourcemanager.resources.models.AliasPathMetadata&text=AliasPathMetadata\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.defaultPath()"
fullName: "com.azure.resourcemanager.resources.models.Alias.defaultPath()"
name: "defaultPath()"
nameWithType: "Alias.defaultPath()"
summary: "Get the default<wbr>Path property: The default path for an alias."
syntax: "public String defaultPath()"
desc: "Get the defaultPath property: The default path for an alias."
returns:
description: "the defaultPath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.resources.models.Alias.defaultPattern()"
fullName: "com.azure.resourcemanager.resources.models.Alias.defaultPattern()"
name: "defaultPattern()"
nameWithType: "Alias.defaultPattern()"
summary: "Get the default<wbr>Pattern property: The default pattern for an alias."
syntax: "public AliasPattern defaultPattern()"
desc: "Get the defaultPattern property: The default pattern for an alias."
returns:
description: "the defaultPattern value."
type: "<xref href=\"com.azure.resourcemanager.resources.models.AliasPattern?alt=com.azure.resourcemanager.resources.models.AliasPattern&text=AliasPattern\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.resources.models.Alias.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "Alias.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Alias 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 Alias fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the Alias."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of Alias from the JsonReader."
returns:
description: "An instance of Alias if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
type: "<xref href=\"com.azure.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.name()"
fullName: "com.azure.resourcemanager.resources.models.Alias.name()"
name: "name()"
nameWithType: "Alias.name()"
summary: "Get the name property: The alias name."
syntax: "public String name()"
desc: "Get the name property: The alias name."
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.resourcemanager.resources.models.Alias.paths()"
fullName: "com.azure.resourcemanager.resources.models.Alias.paths()"
name: "paths()"
nameWithType: "Alias.paths()"
summary: "Get the paths property: The paths for an alias."
syntax: "public List<AliasPath> paths()"
desc: "Get the paths property: The paths for an alias."
returns:
description: "the paths value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.resources.models.AliasPath?alt=com.azure.resourcemanager.resources.models.AliasPath&text=AliasPath\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.resources.models.Alias.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.resources.models.Alias.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "Alias.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\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.type()"
fullName: "com.azure.resourcemanager.resources.models.Alias.type()"
name: "type()"
nameWithType: "Alias.type()"
summary: "Get the type property: The type of the alias."
syntax: "public AliasType type()"
desc: "Get the type property: The type of the alias."
returns:
description: "the type value."
type: "<xref href=\"com.azure.resourcemanager.resources.models.AliasType?alt=com.azure.resourcemanager.resources.models.AliasType&text=AliasType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.validate()"
fullName: "com.azure.resourcemanager.resources.models.Alias.validate()"
name: "validate()"
nameWithType: "Alias.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.resources.models.Alias.withDefaultPath(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.Alias.withDefaultPath(String defaultPath)"
name: "withDefaultPath(String defaultPath)"
nameWithType: "Alias.withDefaultPath(String defaultPath)"
summary: "Set the default<wbr>Path property: The default path for an alias."
parameters:
- description: "the defaultPath value to set."
name: "defaultPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Alias withDefaultPath(String defaultPath)"
desc: "Set the defaultPath property: The default path for an alias."
returns:
description: "the Alias object itself."
type: "<xref href=\"com.azure.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.withDefaultPattern(com.azure.resourcemanager.resources.models.AliasPattern)"
fullName: "com.azure.resourcemanager.resources.models.Alias.withDefaultPattern(AliasPattern defaultPattern)"
name: "withDefaultPattern(AliasPattern defaultPattern)"
nameWithType: "Alias.withDefaultPattern(AliasPattern defaultPattern)"
summary: "Set the default<wbr>Pattern property: The default pattern for an alias."
parameters:
- description: "the defaultPattern value to set."
name: "defaultPattern"
type: "<xref href=\"com.azure.resourcemanager.resources.models.AliasPattern?alt=com.azure.resourcemanager.resources.models.AliasPattern&text=AliasPattern\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Alias withDefaultPattern(AliasPattern defaultPattern)"
desc: "Set the defaultPattern property: The default pattern for an alias."
returns:
description: "the Alias object itself."
type: "<xref href=\"com.azure.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.resources.models.Alias.withName(String name)"
name: "withName(String name)"
nameWithType: "Alias.withName(String name)"
summary: "Set the name property: The alias name."
parameters:
- description: "the name value to set."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Alias withName(String name)"
desc: "Set the name property: The alias name."
returns:
description: "the Alias object itself."
type: "<xref href=\"com.azure.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.withPaths(java.util.List<com.azure.resourcemanager.resources.models.AliasPath>)"
fullName: "com.azure.resourcemanager.resources.models.Alias.withPaths(List<AliasPath> paths)"
name: "withPaths(List<AliasPath> paths)"
nameWithType: "Alias.withPaths(List<AliasPath> paths)"
summary: "Set the paths property: The paths for an alias."
parameters:
- description: "the paths value to set."
name: "paths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.resources.models.AliasPath?alt=com.azure.resourcemanager.resources.models.AliasPath&text=AliasPath\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Alias withPaths(List<AliasPath> paths)"
desc: "Set the paths property: The paths for an alias."
returns:
description: "the Alias object itself."
type: "<xref href=\"com.azure.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.resources.models.Alias.withType(com.azure.resourcemanager.resources.models.AliasType)"
fullName: "com.azure.resourcemanager.resources.models.Alias.withType(AliasType type)"
name: "withType(AliasType type)"
nameWithType: "Alias.withType(AliasType type)"
summary: "Set the type property: The type of the alias."
parameters:
- description: "the type value to set."
name: "type"
type: "<xref href=\"com.azure.resourcemanager.resources.models.AliasType?alt=com.azure.resourcemanager.resources.models.AliasType&text=AliasType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Alias withType(AliasType type)"
desc: "Set the type property: The type of the alias."
returns:
description: "the Alias object itself."
type: "<xref href=\"com.azure.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The alias type."
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.resourcemanager.resources.models.Alias?alt=com.azure.resourcemanager.resources.models.Alias&text=Alias\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.resources.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-resources:2.42.0