-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.documentdb.HashIndex.yml
152 lines (152 loc) · 13.9 KB
/
com.microsoft.azure.documentdb.HashIndex.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.HashIndex"
fullName: "com.microsoft.azure.documentdb.HashIndex"
name: "HashIndex"
nameWithType: "HashIndex"
summary: "Represents a hash index 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\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Index?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.documentdb.Index.Hash(com.microsoft.azure.documentdb.DataType)?alt=com.microsoft.azure.documentdb.Index.Hash&text=Hash\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Index.Hash(com.microsoft.azure.documentdb.DataType,int)?alt=com.microsoft.azure.documentdb.Index.Hash&text=Hash\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Index.Range(com.microsoft.azure.documentdb.DataType)?alt=com.microsoft.azure.documentdb.Index.Range&text=Range\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Index.Range(com.microsoft.azure.documentdb.DataType,int)?alt=com.microsoft.azure.documentdb.Index.Range&text=Range\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Index.Spatial(com.microsoft.azure.documentdb.DataType)?alt=com.microsoft.azure.documentdb.Index.Spatial&text=Spatial\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Index.getKind()?alt=com.microsoft.azure.documentdb.Index.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
- 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 final class **HashIndex**</br> extends <xref href=\"com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.HashIndex.HashIndex(com.microsoft.azure.documentdb.DataType)"
fullName: "com.microsoft.azure.documentdb.HashIndex.HashIndex(DataType dataType)"
name: "HashIndex(DataType dataType)"
nameWithType: "HashIndex.HashIndex(DataType dataType)"
summary: "Specifies an instance of Hash<wbr>Index class with specified Data<wbr>Type."
parameters:
- description: "the data type."
name: "dataType"
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashIndex(DataType dataType)"
desc: "Specifies an instance of HashIndex class with specified DataType.\n\nHere is an example to instantiate HashIndex class passing in the DataType:\n\n```java\nHashIndex hashIndex = new HashIndex(DataType.String);\n```"
- uid: "com.microsoft.azure.documentdb.HashIndex.HashIndex(com.microsoft.azure.documentdb.DataType,int)"
fullName: "com.microsoft.azure.documentdb.HashIndex.HashIndex(DataType dataType, int precision)"
name: "HashIndex(DataType dataType, int precision)"
nameWithType: "HashIndex.HashIndex(DataType dataType, int precision)"
summary: "Initializes a new instance of the Hash<wbr>Index class with specified Data<wbr>Type and precision."
parameters:
- description: "the data type."
name: "dataType"
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
- description: "the precision."
name: "precision"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashIndex(DataType dataType, int precision)"
desc: "Initializes a new instance of the HashIndex class with specified DataType and precision.\n\nHere is an example to instantiate HashIndex class passing in the DataType:\n\n```java\nHashIndex hashIndex = new HashIndex(DataType.String, 3);\n```"
- uid: "com.microsoft.azure.documentdb.HashIndex.HashIndex(java.lang.String)"
fullName: "com.microsoft.azure.documentdb.HashIndex.HashIndex(String jsonString)"
name: "HashIndex(String jsonString)"
nameWithType: "HashIndex.HashIndex(String jsonString)"
summary: "Initializes a new instance of the Hash<wbr>Index class with json string."
parameters:
- description: "the json string that represents the index."
name: "jsonString"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashIndex(String jsonString)"
desc: "Initializes a new instance of the HashIndex class with json string."
- uid: "com.microsoft.azure.documentdb.HashIndex.HashIndex(org.json.JSONObject)"
fullName: "com.microsoft.azure.documentdb.HashIndex.HashIndex(JSONObject jsonObject)"
name: "HashIndex(JSONObject jsonObject)"
nameWithType: "HashIndex.HashIndex(JSONObject jsonObject)"
summary: "Initializes a new instance of the Hash<wbr>Index class with json object."
parameters:
- description: "the json object that represents the index."
name: "jsonObject"
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashIndex(JSONObject jsonObject)"
desc: "Initializes a new instance of the HashIndex class with json object."
methods:
- uid: "com.microsoft.azure.documentdb.HashIndex.getDataType()"
fullName: "com.microsoft.azure.documentdb.HashIndex.getDataType()"
name: "getDataType()"
nameWithType: "HashIndex.getDataType()"
summary: "Gets data type."
syntax: "public DataType getDataType()"
desc: "Gets data type."
returns:
description: "the data type."
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.HashIndex.getPrecision()"
fullName: "com.microsoft.azure.documentdb.HashIndex.getPrecision()"
name: "getPrecision()"
nameWithType: "HashIndex.getPrecision()"
summary: "Gets precision."
syntax: "public int getPrecision()"
desc: "Gets precision."
returns:
description: "the precision."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.HashIndex.setDataType(com.microsoft.azure.documentdb.DataType)"
fullName: "com.microsoft.azure.documentdb.HashIndex.setDataType(DataType dataType)"
name: "setDataType(DataType dataType)"
nameWithType: "HashIndex.setDataType(DataType dataType)"
summary: "Sets data type."
parameters:
- description: "the data type."
name: "dataType"
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setDataType(DataType dataType)"
desc: "Sets data type."
- uid: "com.microsoft.azure.documentdb.HashIndex.setPrecision(int)"
fullName: "com.microsoft.azure.documentdb.HashIndex.setPrecision(int precision)"
name: "setPrecision(int precision)"
nameWithType: "HashIndex.setPrecision(int precision)"
summary: "Sets precision."
parameters:
- description: "the precision."
name: "precision"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setPrecision(int precision)"
desc: "Sets precision."
type: "class"
desc: "Represents a hash index in the Azure Cosmos DB database service."
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7