-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.microsoft.azure.documentdb.IncludedPath.yml
122 lines (122 loc) · 11 KB
/
com.microsoft.azure.documentdb.IncludedPath.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.IncludedPath"
fullName: "com.microsoft.azure.documentdb.IncludedPath"
name: "IncludedPath"
nameWithType: "IncludedPath"
summary: "Represents an included path of the Indexing<wbr>Policy in the Azure Cosmos DB database service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection&text=<T>getCollection\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getObject(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getObject&text=<T>getObject\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>set(java.lang.String,T)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>set&text=<T>set\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>toObject(java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>toObject&text=<T>toObject\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.get(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.get&text=get\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getBoolean(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getBoolean&text=getBoolean\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getCollection(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getCollection&text=getCollection\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getDouble(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getDouble&text=getDouble\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getHashMap()?alt=com.microsoft.azure.documentdb.JsonSerializable.getHashMap&text=getHashMap\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getInt(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getInt&text=getInt\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLogger()?alt=com.microsoft.azure.documentdb.JsonSerializable.getLogger&text=getLogger\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLong(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getLong&text=getLong\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getMapper()?alt=com.microsoft.azure.documentdb.JsonSerializable.getMapper&text=getMapper\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObject(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObject&text=getObject\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(java.util.Collection<java.lang.String>)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath&text=getObjectByPath\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getString(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getString&text=getString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.has(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.has&text=has\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.remove(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.remove&text=remove\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson()?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson(com.microsoft.azure.documentdb.SerializationFormattingPolicy)?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString()?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString(int)?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **IncludedPath**</br> extends <xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.IncludedPath.IncludedPath()"
fullName: "com.microsoft.azure.documentdb.IncludedPath.IncludedPath()"
name: "IncludedPath()"
nameWithType: "IncludedPath.IncludedPath()"
summary: "Constructor."
syntax: "public IncludedPath()"
desc: "Constructor."
- uid: "com.microsoft.azure.documentdb.IncludedPath.IncludedPath(java.lang.String)"
fullName: "com.microsoft.azure.documentdb.IncludedPath.IncludedPath(String jsonString)"
name: "IncludedPath(String jsonString)"
nameWithType: "IncludedPath.IncludedPath(String jsonString)"
summary: "Constructor."
parameters:
- description: "the json string that represents the included path."
name: "jsonString"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public IncludedPath(String jsonString)"
desc: "Constructor."
- uid: "com.microsoft.azure.documentdb.IncludedPath.IncludedPath(org.json.JSONObject)"
fullName: "com.microsoft.azure.documentdb.IncludedPath.IncludedPath(JSONObject jsonObject)"
name: "IncludedPath(JSONObject jsonObject)"
nameWithType: "IncludedPath.IncludedPath(JSONObject jsonObject)"
summary: "Constructor."
parameters:
- description: "the json object that represents the included path."
name: "jsonObject"
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
syntax: "public IncludedPath(JSONObject jsonObject)"
desc: "Constructor."
methods:
- uid: "com.microsoft.azure.documentdb.IncludedPath.getIndexes()"
fullName: "com.microsoft.azure.documentdb.IncludedPath.getIndexes()"
name: "getIndexes()"
nameWithType: "IncludedPath.getIndexes()"
summary: "Gets the paths that are chosen to be indexed by the user."
syntax: "public Collection<Index> getIndexes()"
desc: "Gets the paths that are chosen to be indexed by the user."
returns:
description: "the included paths."
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.IncludedPath.getPath()"
fullName: "com.microsoft.azure.documentdb.IncludedPath.getPath()"
name: "getPath()"
nameWithType: "IncludedPath.getPath()"
summary: "Gets path."
syntax: "public String getPath()"
desc: "Gets path."
returns:
description: "the path."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.IncludedPath.setIndexes(java.util.Collection<com.microsoft.azure.documentdb.Index>)"
fullName: "com.microsoft.azure.documentdb.IncludedPath.setIndexes(Collection<Index> indexes)"
name: "setIndexes(Collection<Index> indexes)"
nameWithType: "IncludedPath.setIndexes(Collection<Index> indexes)"
parameters:
- name: "indexes"
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public void setIndexes(Collection<Index> indexes)"
- uid: "com.microsoft.azure.documentdb.IncludedPath.setPath(java.lang.String)"
fullName: "com.microsoft.azure.documentdb.IncludedPath.setPath(String path)"
name: "setPath(String path)"
nameWithType: "IncludedPath.setPath(String path)"
summary: "Sets path."
parameters:
- description: "the path."
name: "path"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setPath(String path)"
desc: "Sets path."
type: "class"
desc: "Represents an included path of the IndexingPolicy in the Azure Cosmos DB database service."
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7