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

102 строки
6.9 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cosmos.models.ExcludedPath"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath"
name: "ExcludedPath"
nameWithType: "ExcludedPath"
summary: "The Excluded<wbr>Path model."
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 **ExcludedPath**</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.cosmos.models.ExcludedPath?alt=com.azure.resourcemanager.cosmos.models.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.cosmos.models.ExcludedPath.ExcludedPath()"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath.ExcludedPath()"
name: "ExcludedPath()"
nameWithType: "ExcludedPath.ExcludedPath()"
summary: "Creates an instance of Excluded<wbr>Path class."
syntax: "public ExcludedPath()"
desc: "Creates an instance of ExcludedPath class."
methods:
- uid: "com.azure.resourcemanager.cosmos.models.ExcludedPath.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "ExcludedPath.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Excluded<wbr>Path 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 ExcludedPath fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the ExcludedPath."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of ExcludedPath from the JsonReader."
returns:
description: "An instance of ExcludedPath if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ExcludedPath?alt=com.azure.resourcemanager.cosmos.models.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.ExcludedPath.path()"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath.path()"
name: "path()"
nameWithType: "ExcludedPath.path()"
summary: "Get the path property: The path for which the indexing behavior applies to."
syntax: "public String path()"
desc: "Get the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/\\*)."
returns:
description: "the path value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cosmos.models.ExcludedPath.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "ExcludedPath.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.cosmos.models.ExcludedPath.validate()"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath.validate()"
name: "validate()"
nameWithType: "ExcludedPath.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cosmos.models.ExcludedPath.withPath(java.lang.String)"
fullName: "com.azure.resourcemanager.cosmos.models.ExcludedPath.withPath(String path)"
name: "withPath(String path)"
nameWithType: "ExcludedPath.withPath(String path)"
summary: "Set the path property: The path for which the indexing behavior applies to."
parameters:
- description: "the path value to set."
name: "path"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ExcludedPath withPath(String path)"
desc: "Set the path property: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/\\*)."
returns:
description: "the ExcludedPath object itself."
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ExcludedPath?alt=com.azure.resourcemanager.cosmos.models.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The ExcludedPath model."
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.cosmos.models.ExcludedPath?alt=com.azure.resourcemanager.cosmos.models.ExcludedPath&text=ExcludedPath\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cosmos.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.42.0