-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.documentdb.Document.yml
128 lines (128 loc) · 13.5 KB
/
com.microsoft.azure.documentdb.Document.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
### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.Document"
fullName: "com.microsoft.azure.documentdb.Document"
name: "Document"
nameWithType: "Document"
summary: "Represents a document 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.Resource?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=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getETag()?alt=com.microsoft.azure.documentdb.Resource.getETag&text=getETag\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getId()?alt=com.microsoft.azure.documentdb.Resource.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getResourceId()?alt=com.microsoft.azure.documentdb.Resource.getResourceId&text=getResourceId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getSelfLink()?alt=com.microsoft.azure.documentdb.Resource.getSelfLink&text=getSelfLink\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getTimestamp()?alt=com.microsoft.azure.documentdb.Resource.getTimestamp&text=getTimestamp\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setId&text=setId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setResourceId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setResourceId&text=setResourceId\" 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 **Document**</br> extends <xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.Document.Document()"
fullName: "com.microsoft.azure.documentdb.Document.Document()"
name: "Document()"
nameWithType: "Document.Document()"
summary: "Initialize a document object."
syntax: "public Document()"
desc: "Initialize a document object."
- uid: "com.microsoft.azure.documentdb.Document.Document(java.lang.String)"
fullName: "com.microsoft.azure.documentdb.Document.Document(String jsonString)"
name: "Document(String jsonString)"
nameWithType: "Document.Document(String jsonString)"
summary: "Initialize a document object from json string."
parameters:
- description: "the json string that represents the document object."
name: "jsonString"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Document(String jsonString)"
desc: "Initialize a document object from json string."
- uid: "com.microsoft.azure.documentdb.Document.Document(java.lang.String,com.fasterxml.jackson.databind.ObjectMapper)"
fullName: "com.microsoft.azure.documentdb.Document.Document(String jsonString, ObjectMapper objectMapper)"
name: "Document(String jsonString, ObjectMapper objectMapper)"
nameWithType: "Document.Document(String jsonString, ObjectMapper objectMapper)"
summary: "Initialize a document object from json string."
parameters:
- description: "the json string that represents the document object."
name: "jsonString"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the custom object mapper"
name: "objectMapper"
type: "<xref href=\"com.fasterxml.jackson.databind.ObjectMapper?alt=com.fasterxml.jackson.databind.ObjectMapper&text=ObjectMapper\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Document(String jsonString, ObjectMapper objectMapper)"
desc: "Initialize a document object from json string."
- uid: "com.microsoft.azure.documentdb.Document.Document(org.json.JSONObject)"
fullName: "com.microsoft.azure.documentdb.Document.Document(JSONObject jsonObject)"
name: "Document(JSONObject jsonObject)"
nameWithType: "Document.Document(JSONObject jsonObject)"
summary: "Initialize a document object from json object."
parameters:
- description: "the json object that represents the document object."
name: "jsonObject"
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Document(JSONObject jsonObject)"
desc: "Initialize a document object from json object."
methods:
- uid: "com.microsoft.azure.documentdb.Document.getTimeToLive()"
fullName: "com.microsoft.azure.documentdb.Document.getTimeToLive()"
name: "getTimeToLive()"
nameWithType: "Document.getTimeToLive()"
summary: "Gets the document's time-to-live value."
syntax: "public Integer getTimeToLive()"
desc: "Gets the document's time-to-live value."
returns:
description: "the document's time-to-live value in seconds."
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.Document.setTimeToLive(java.lang.Integer)"
fullName: "com.microsoft.azure.documentdb.Document.setTimeToLive(Integer timeToLive)"
name: "setTimeToLive(Integer timeToLive)"
nameWithType: "Document.setTimeToLive(Integer timeToLive)"
summary: "Sets the document's time-to-live value."
parameters:
- description: "the document's time-to-live value in seconds."
name: "timeToLive"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setTimeToLive(Integer timeToLive)"
desc: "Sets the document's time-to-live value.\n\nA document's time-to-live value is an optional property. If set, the document expires after the specified number of seconds since its last write time. The value of this property should be one of the following:\n\nnull - indicates the time-to-live value for this document inherits from the parent collection's default time-to-live value.\n\nnonzero positive integer - indicates the number of seconds before the document expires. It overrides the default time-to-live value specified on the parent collection, unless the parent collection's default time-to-live is null.\n\n\\-1 - indicates the document never expires. It overrides the default time-to-live value specified on the parent collection, unless the parent collection's default time-to-live is null."
type: "class"
desc: "Represents a document in the Azure Cosmos DB database service.\n\nA document is a structured JSON document. There is no set schema for the JSON documents, and a document may contain any number of custom properties as well as an optional list of attachments. Document is an application resource and can be authorized using the master key or resource keys."
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7