-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.microsoft.azure.documentdb.DocumentClient.yml
2142 lines (2142 loc) · 188 KB
/
com.microsoft.azure.documentdb.DocumentClient.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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.DocumentClient"
fullName: "com.microsoft.azure.documentdb.DocumentClient"
name: "DocumentClient"
nameWithType: "DocumentClient"
summary: "Provides a client-side logical representation of the Azure Cosmos DB service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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.toString()?alt=java.lang.Object.toString&text=toString\" 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 **DocumentClient**</br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.microsoft.azure.documentdb.internal.CollectionCacheInternal?alt=com.microsoft.azure.documentdb.internal.CollectionCacheInternal&text=CollectionCacheInternal\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(java.lang.String,java.lang.String,com.fasterxml.jackson.databind.ObjectMapper,com.microsoft.azure.documentdb.ConnectionPolicy,com.microsoft.azure.documentdb.ConsistencyLevel)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(String serviceEndpoint, String masterKey, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
name: "DocumentClient(String serviceEndpoint, String masterKey, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
nameWithType: "DocumentClient.DocumentClient(String serviceEndpoint, String masterKey, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
summary: "Initializes a new instance of the Document<wbr>Client class using the specified Azure Cosmos DB service endpoint and keys."
parameters:
- description: "the URI of the service end point."
name: "serviceEndpoint"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the master key."
name: "masterKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the custom objectMapper"
name: "objectMapper"
type: "<xref href=\"com.fasterxml.jackson.databind.ObjectMapper?alt=com.fasterxml.jackson.databind.ObjectMapper&text=ObjectMapper\" data-throw-if-not-resolved=\"False\" />"
- description: "the connection policy."
name: "connectionPolicy"
type: "<xref href=\"com.microsoft.azure.documentdb.ConnectionPolicy?alt=com.microsoft.azure.documentdb.ConnectionPolicy&text=ConnectionPolicy\" data-throw-if-not-resolved=\"False\" />"
- description: "the desired consistency level."
name: "desiredConsistencyLevel"
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyLevel?alt=com.microsoft.azure.documentdb.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DocumentClient(String serviceEndpoint, String masterKey, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
desc: "Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint and keys."
- uid: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.ConnectionPolicy,com.microsoft.azure.documentdb.ConsistencyLevel)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(String serviceEndpoint, String masterKey, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
name: "DocumentClient(String serviceEndpoint, String masterKey, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
nameWithType: "DocumentClient.DocumentClient(String serviceEndpoint, String masterKey, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
summary: "Initializes a new instance of the Document<wbr>Client class using the specified Azure Cosmos DB service endpoint and keys."
parameters:
- description: "the URI of the service end point."
name: "serviceEndpoint"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the master key."
name: "masterKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the connection policy."
name: "connectionPolicy"
type: "<xref href=\"com.microsoft.azure.documentdb.ConnectionPolicy?alt=com.microsoft.azure.documentdb.ConnectionPolicy&text=ConnectionPolicy\" data-throw-if-not-resolved=\"False\" />"
- description: "the desired consistency level."
name: "desiredConsistencyLevel"
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyLevel?alt=com.microsoft.azure.documentdb.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DocumentClient(String serviceEndpoint, String masterKey, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
desc: "Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint and keys."
- uid: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(java.lang.String,java.util.List<com.microsoft.azure.documentdb.Permission>,com.fasterxml.jackson.databind.ObjectMapper,com.microsoft.azure.documentdb.ConnectionPolicy,com.microsoft.azure.documentdb.ConsistencyLevel)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
name: "DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
nameWithType: "DocumentClient.DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
summary: "Initializes a new instance of the Microsoft.<wbr>Azure.<wbr>Documents.<wbr>Client.<wbr>Document<wbr>Client class using the specified Azure Cosmos DB service endpoint and permissions."
parameters:
- description: "the URI of the service end point."
name: "serviceEndpoint"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the permission feed."
name: "permissionFeed"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
- description: "the custom objectMapper"
name: "objectMapper"
type: "<xref href=\"com.fasterxml.jackson.databind.ObjectMapper?alt=com.fasterxml.jackson.databind.ObjectMapper&text=ObjectMapper\" data-throw-if-not-resolved=\"False\" />"
- description: "the connection policy."
name: "connectionPolicy"
type: "<xref href=\"com.microsoft.azure.documentdb.ConnectionPolicy?alt=com.microsoft.azure.documentdb.ConnectionPolicy&text=ConnectionPolicy\" data-throw-if-not-resolved=\"False\" />"
- description: "the desired consistency level."
name: "desiredConsistencyLevel"
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyLevel?alt=com.microsoft.azure.documentdb.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
desc: "Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint and permissions."
- uid: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(java.lang.String,java.util.List<com.microsoft.azure.documentdb.Permission>,com.microsoft.azure.documentdb.ConnectionPolicy,com.microsoft.azure.documentdb.ConsistencyLevel)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
name: "DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
nameWithType: "DocumentClient.DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
summary: "Initializes a new instance of the Microsoft.<wbr>Azure.<wbr>Documents.<wbr>Client.<wbr>Document<wbr>Client class using the specified Azure Cosmos DB service endpoint and permissions."
parameters:
- description: "the URI of the service end point."
name: "serviceEndpoint"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the permission feed."
name: "permissionFeed"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
- description: "the connection policy."
name: "connectionPolicy"
type: "<xref href=\"com.microsoft.azure.documentdb.ConnectionPolicy?alt=com.microsoft.azure.documentdb.ConnectionPolicy&text=ConnectionPolicy\" data-throw-if-not-resolved=\"False\" />"
- description: "the desired consistency level."
name: "desiredConsistencyLevel"
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyLevel?alt=com.microsoft.azure.documentdb.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)"
desc: "Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint and permissions."
fields:
- uid: "com.microsoft.azure.documentdb.DocumentClient.PartitionResolverErrorMessage"
fullName: "com.microsoft.azure.documentdb.DocumentClient.PartitionResolverErrorMessage"
name: "PartitionResolverErrorMessage"
nameWithType: "DocumentClient.PartitionResolverErrorMessage"
modifiers:
- "protected"
- "static"
- "final"
field:
value: "Couldn't find any partition resolvers for the database link provided. Ensure that the link you used when registering the partition resolvers matches the link provided or you need to register both types of database link(self link as well as ID based link)."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>protected static final String PartitionResolverErrorMessage"
methods:
- uid: "com.microsoft.azure.documentdb.DocumentClient.close()"
fullName: "com.microsoft.azure.documentdb.DocumentClient.close()"
name: "close()"
nameWithType: "DocumentClient.close()"
summary: "Close this Document<wbr>Client instance"
syntax: "public void close()"
desc: "Close this DocumentClient instance"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createAttachment(java.lang.String,com.microsoft.azure.documentdb.Attachment,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createAttachment(String documentLink, Attachment attachment, RequestOptions options)"
name: "createAttachment(String documentLink, Attachment attachment, RequestOptions options)"
nameWithType: "DocumentClient.createAttachment(String documentLink, Attachment attachment, RequestOptions options)"
summary: "Creates an attachment."
parameters:
- description: "the document link."
name: "documentLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the attachment to create."
name: "attachment"
type: "<xref href=\"com.microsoft.azure.documentdb.Attachment?alt=com.microsoft.azure.documentdb.Attachment&text=Attachment\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Attachment> createAttachment(String documentLink, Attachment attachment, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates an attachment."
returns:
description: "the resource response with the created attachment."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Attachment?alt=com.microsoft.azure.documentdb.Attachment&text=Attachment\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createAttachment(java.lang.String,java.io.InputStream,com.microsoft.azure.documentdb.MediaOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
name: "createAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
nameWithType: "DocumentClient.createAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
summary: "Creates an attachment."
parameters:
- description: "the document link."
name: "documentLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the media stream for creating the attachment."
name: "mediaStream"
type: "<xref href=\"java.io.InputStream?alt=java.io.InputStream&text=InputStream\" data-throw-if-not-resolved=\"False\" />"
- description: "the media options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.MediaOptions?alt=com.microsoft.azure.documentdb.MediaOptions&text=MediaOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Attachment> createAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates an attachment."
returns:
description: "the resource response with the created attachment."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Attachment?alt=com.microsoft.azure.documentdb.Attachment&text=Attachment\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createCollection(java.lang.String,com.microsoft.azure.documentdb.DocumentCollection,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createCollection(String databaseLink, DocumentCollection collection, RequestOptions options)"
name: "createCollection(String databaseLink, DocumentCollection collection, RequestOptions options)"
nameWithType: "DocumentClient.createCollection(String databaseLink, DocumentCollection collection, RequestOptions options)"
summary: "Creates a document collection."
parameters:
- description: "the database link."
name: "databaseLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the collection."
name: "collection"
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentCollection?alt=com.microsoft.azure.documentdb.DocumentCollection&text=DocumentCollection\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<DocumentCollection> createCollection(String databaseLink, DocumentCollection collection, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a document collection."
returns:
description: "the resource response with the created collection."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.DocumentCollection?alt=com.microsoft.azure.documentdb.DocumentCollection&text=DocumentCollection\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createDatabase(com.microsoft.azure.documentdb.Database,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createDatabase(Database database, RequestOptions options)"
name: "createDatabase(Database database, RequestOptions options)"
nameWithType: "DocumentClient.createDatabase(Database database, RequestOptions options)"
summary: "Creates a database."
parameters:
- description: "the database."
name: "database"
type: "<xref href=\"com.microsoft.azure.documentdb.Database?alt=com.microsoft.azure.documentdb.Database&text=Database\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Database> createDatabase(Database database, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a database."
returns:
description: "the resource response with the created database."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Database?alt=com.microsoft.azure.documentdb.Database&text=Database\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createDocument(java.lang.String,java.lang.Object,com.microsoft.azure.documentdb.RequestOptions,boolean)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
name: "createDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
nameWithType: "DocumentClient.createDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
summary: "Creates a document."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the document represented as a POJO or Document object."
name: "document"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "the flag for disabling automatic id generation."
name: "disableAutomaticIdGeneration"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Document> createDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a document."
returns:
description: "the resource response with the created document."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createPermission(java.lang.String,com.microsoft.azure.documentdb.Permission,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createPermission(String userLink, Permission permission, RequestOptions options)"
name: "createPermission(String userLink, Permission permission, RequestOptions options)"
nameWithType: "DocumentClient.createPermission(String userLink, Permission permission, RequestOptions options)"
summary: "Creates a permission."
parameters:
- description: "the user link."
name: "userLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the permission to create."
name: "permission"
type: "<xref href=\"com.microsoft.azure.documentdb.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Permission> createPermission(String userLink, Permission permission, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a permission."
returns:
description: "the resource response with the created permission."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createStoredProcedure(java.lang.String,com.microsoft.azure.documentdb.StoredProcedure,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
name: "createStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
nameWithType: "DocumentClient.createStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
summary: "Creates a stored procedure."
parameters:
- description: "the collection link."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the stored procedure to create."
name: "storedProcedure"
type: "<xref href=\"com.microsoft.azure.documentdb.StoredProcedure?alt=com.microsoft.azure.documentdb.StoredProcedure&text=StoredProcedure\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<StoredProcedure> createStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a stored procedure."
returns:
description: "the resource response with the created stored procedure."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.StoredProcedure?alt=com.microsoft.azure.documentdb.StoredProcedure&text=StoredProcedure\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createTrigger(java.lang.String,com.microsoft.azure.documentdb.Trigger,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
name: "createTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
nameWithType: "DocumentClient.createTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
summary: "Creates a trigger."
parameters:
- description: "the collection link."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the trigger."
name: "trigger"
type: "<xref href=\"com.microsoft.azure.documentdb.Trigger?alt=com.microsoft.azure.documentdb.Trigger&text=Trigger\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Trigger> createTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a trigger."
returns:
description: "the resource response with the created trigger."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Trigger?alt=com.microsoft.azure.documentdb.Trigger&text=Trigger\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createUser(java.lang.String,com.microsoft.azure.documentdb.User,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createUser(String databaseLink, User user, RequestOptions options)"
name: "createUser(String databaseLink, User user, RequestOptions options)"
nameWithType: "DocumentClient.createUser(String databaseLink, User user, RequestOptions options)"
summary: "Creates a user."
parameters:
- description: "the database link."
name: "databaseLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the user to create."
name: "user"
type: "<xref href=\"com.microsoft.azure.documentdb.User?alt=com.microsoft.azure.documentdb.User&text=User\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<User> createUser(String databaseLink, User user, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a user."
returns:
description: "the resource response with the created user."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.User?alt=com.microsoft.azure.documentdb.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.createUserDefinedFunction(java.lang.String,com.microsoft.azure.documentdb.UserDefinedFunction,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.createUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
name: "createUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
nameWithType: "DocumentClient.createUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
summary: "Creates a user defined function."
parameters:
- description: "the collection link."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the user defined function."
name: "udf"
type: "<xref href=\"com.microsoft.azure.documentdb.UserDefinedFunction?alt=com.microsoft.azure.documentdb.UserDefinedFunction&text=UserDefinedFunction\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<UserDefinedFunction> createUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Creates a user defined function."
returns:
description: "the resource response with the created user defined function."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.UserDefinedFunction?alt=com.microsoft.azure.documentdb.UserDefinedFunction&text=UserDefinedFunction\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteAttachment(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteAttachment(String attachmentLink, RequestOptions options)"
name: "deleteAttachment(String attachmentLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteAttachment(String attachmentLink, RequestOptions options)"
summary: "Deletes an attachment."
parameters:
- description: "the attachment link."
name: "attachmentLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Attachment> deleteAttachment(String attachmentLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes an attachment."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Attachment?alt=com.microsoft.azure.documentdb.Attachment&text=Attachment\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteCollection(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteCollection(String collectionLink, RequestOptions options)"
name: "deleteCollection(String collectionLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteCollection(String collectionLink, RequestOptions options)"
summary: "Deletes a document collection by the collection link."
parameters:
- description: "the collection link."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<DocumentCollection> deleteCollection(String collectionLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a document collection by the collection link."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.DocumentCollection?alt=com.microsoft.azure.documentdb.DocumentCollection&text=DocumentCollection\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteConflict(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteConflict(String conflictLink, RequestOptions options)"
name: "deleteConflict(String conflictLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteConflict(String conflictLink, RequestOptions options)"
summary: "Deletes a conflict."
parameters:
- description: "the conflict link."
name: "conflictLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Conflict> deleteConflict(String conflictLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a conflict."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Conflict?alt=com.microsoft.azure.documentdb.Conflict&text=Conflict\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteDatabase(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteDatabase(String databaseLink, RequestOptions options)"
name: "deleteDatabase(String databaseLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteDatabase(String databaseLink, RequestOptions options)"
summary: "Deletes a database."
parameters:
- description: "the database link."
name: "databaseLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Database> deleteDatabase(String databaseLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a database."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Database?alt=com.microsoft.azure.documentdb.Database&text=Database\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteDocument(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteDocument(String documentLink, RequestOptions options)"
name: "deleteDocument(String documentLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteDocument(String documentLink, RequestOptions options)"
summary: "Deletes a document by the document link."
parameters:
- description: "the document link."
name: "documentLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Document> deleteDocument(String documentLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a document by the document link."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deletePermission(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deletePermission(String permissionLink, RequestOptions options)"
name: "deletePermission(String permissionLink, RequestOptions options)"
nameWithType: "DocumentClient.deletePermission(String permissionLink, RequestOptions options)"
summary: "Deletes a permission."
parameters:
- description: "the permission link."
name: "permissionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Permission> deletePermission(String permissionLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a permission."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteStoredProcedure(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteStoredProcedure(String storedProcedureLink, RequestOptions options)"
name: "deleteStoredProcedure(String storedProcedureLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteStoredProcedure(String storedProcedureLink, RequestOptions options)"
summary: "Deletes a stored procedure by the stored procedure link."
parameters:
- description: "the stored procedure link."
name: "storedProcedureLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<StoredProcedure> deleteStoredProcedure(String storedProcedureLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a stored procedure by the stored procedure link."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.StoredProcedure?alt=com.microsoft.azure.documentdb.StoredProcedure&text=StoredProcedure\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteTrigger(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteTrigger(String triggerLink, RequestOptions options)"
name: "deleteTrigger(String triggerLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteTrigger(String triggerLink, RequestOptions options)"
summary: "Deletes a trigger."
parameters:
- description: "the trigger link."
name: "triggerLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<Trigger> deleteTrigger(String triggerLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a trigger."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Trigger?alt=com.microsoft.azure.documentdb.Trigger&text=Trigger\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteUser(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteUser(String userLink, RequestOptions options)"
name: "deleteUser(String userLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteUser(String userLink, RequestOptions options)"
summary: "Deletes a user."
parameters:
- description: "the user link."
name: "userLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<User> deleteUser(String userLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a user."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.User?alt=com.microsoft.azure.documentdb.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.deleteUserDefinedFunction(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.deleteUserDefinedFunction(String udfLink, RequestOptions options)"
name: "deleteUserDefinedFunction(String udfLink, RequestOptions options)"
nameWithType: "DocumentClient.deleteUserDefinedFunction(String udfLink, RequestOptions options)"
summary: "Deletes a user defined function."
parameters:
- description: "the user defined function link."
name: "udfLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResourceResponse<UserDefinedFunction> deleteUserDefinedFunction(String udfLink, RequestOptions options)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Deletes a user defined function."
returns:
description: "the resource response."
type: "<xref href=\"com.microsoft.azure.documentdb.ResourceResponse?alt=com.microsoft.azure.documentdb.ResourceResponse&text=ResourceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.UserDefinedFunction?alt=com.microsoft.azure.documentdb.UserDefinedFunction&text=UserDefinedFunction\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.executeStoredProcedure(java.lang.String,com.microsoft.azure.documentdb.RequestOptions,java.lang.Object[])"
fullName: "com.microsoft.azure.documentdb.DocumentClient.executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)"
name: "executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)"
nameWithType: "DocumentClient.executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)"
summary: "Executes a stored procedure by the stored procedure link."
parameters:
- description: "the stored procedure link."
name: "storedProcedureLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the request options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.RequestOptions?alt=com.microsoft.azure.documentdb.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "the array of procedure parameter values."
name: "procedureParams"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public StoredProcedureResponse executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Executes a stored procedure by the stored procedure link."
returns:
description: "the stored procedure response."
type: "<xref href=\"com.microsoft.azure.documentdb.StoredProcedureResponse?alt=com.microsoft.azure.documentdb.StoredProcedureResponse&text=StoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.executeStoredProcedure(java.lang.String,java.lang.Object[])"
fullName: "com.microsoft.azure.documentdb.DocumentClient.executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)"
name: "executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)"
nameWithType: "DocumentClient.executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)"
summary: "Executes a stored procedure by the stored procedure link."
parameters:
- description: "the stored procedure link."
name: "storedProcedureLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the array of procedure parameter values."
name: "procedureParams"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public StoredProcedureResponse executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Executes a stored procedure by the stored procedure link."
returns:
description: "the stored procedure response."
type: "<xref href=\"com.microsoft.azure.documentdb.StoredProcedureResponse?alt=com.microsoft.azure.documentdb.StoredProcedureResponse&text=StoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.getConnectionPolicy()"
fullName: "com.microsoft.azure.documentdb.DocumentClient.getConnectionPolicy()"
name: "getConnectionPolicy()"
nameWithType: "DocumentClient.getConnectionPolicy()"
syntax: "public ConnectionPolicy getConnectionPolicy()"
returns:
type: "<xref href=\"com.microsoft.azure.documentdb.ConnectionPolicy?alt=com.microsoft.azure.documentdb.ConnectionPolicy&text=ConnectionPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.getDatabaseAccount()"
fullName: "com.microsoft.azure.documentdb.DocumentClient.getDatabaseAccount()"
name: "getDatabaseAccount()"
nameWithType: "DocumentClient.getDatabaseAccount()"
summary: "Gets database account information."
syntax: "public DatabaseAccount getDatabaseAccount()"
exceptions:
- description: "the document client exception."
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
desc: "Gets database account information."
returns:
description: "the database account."
type: "<xref href=\"com.microsoft.azure.documentdb.DatabaseAccount?alt=com.microsoft.azure.documentdb.DatabaseAccount&text=DatabaseAccount\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.getPartitionResolver(java.lang.String)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.getPartitionResolver(String databaseLink)"
name: "getPartitionResolver(String databaseLink)"
nameWithType: "DocumentClient.getPartitionResolver(String databaseLink)"
modifiers:
- "protected"
parameters:
- name: "databaseLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>protected PartitionResolver getPartitionResolver(String databaseLink)"
returns:
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionResolver?alt=com.microsoft.azure.documentdb.PartitionResolver&text=PartitionResolver\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.getReadEndpoint()"
fullName: "com.microsoft.azure.documentdb.DocumentClient.getReadEndpoint()"
name: "getReadEndpoint()"
nameWithType: "DocumentClient.getReadEndpoint()"
summary: "Gets the current read endpoint chosen based on availability and preference."
syntax: "public URI getReadEndpoint()"
desc: "Gets the current read endpoint chosen based on availability and preference."
returns:
description: "the read endpoint URI"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.getServiceEndpoint()"
fullName: "com.microsoft.azure.documentdb.DocumentClient.getServiceEndpoint()"
name: "getServiceEndpoint()"
nameWithType: "DocumentClient.getServiceEndpoint()"
summary: "Gets the default service endpoint as passed in by the user during construction."
syntax: "public URI getServiceEndpoint()"
desc: "Gets the default service endpoint as passed in by the user during construction."
returns:
description: "the service endpoint URI"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.getWriteEndpoint()"
fullName: "com.microsoft.azure.documentdb.DocumentClient.getWriteEndpoint()"
name: "getWriteEndpoint()"
nameWithType: "DocumentClient.getWriteEndpoint()"
summary: "Gets the current write endpoint chosen based on availability and preference."
syntax: "public URI getWriteEndpoint()"
desc: "Gets the current write endpoint chosen based on availability and preference."
returns:
description: "the write endpoint URI"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions)"
name: "queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions)"
nameWithType: "DocumentClient.queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions)"
summary: "Query for aggregation values in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "feedOptions"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public List<Object> queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions)"
desc: "Query for aggregation values in a document collection."
returns:
description: "a list containing the aggregation values"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions,java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions, Object partitionKey)"
name: "queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions, Object partitionKey)"
nameWithType: "DocumentClient.queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions, Object partitionKey)"
summary: "Query for aggregation values in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "feedOptions"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "the partitionKey."
name: "partitionKey"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
syntax: "public List<Object> queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions, Object partitionKey)"
desc: "Query for aggregation values in a document collection."
returns:
description: "a list containing the aggregation values"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions)"
name: "queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions)"
nameWithType: "DocumentClient.queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions)"
summary: "Query for aggregation values in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query string."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "feedOptions"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public List<Object> queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions)"
desc: "Query for aggregation values in a document collection."
returns:
description: "a list containing the aggregation values"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions,java.lang.String)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions, String partitionKey)"
name: "queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions, String partitionKey)"
nameWithType: "DocumentClient.queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions, String partitionKey)"
summary: "Query for aggregation values in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query string."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "feedOptions"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "the partitionKey."
name: "partitionKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public List<Object> queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions, String partitionKey)"
desc: "Query for aggregation values in a document collection."
returns:
description: "a list containing the aggregation values"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryAttachments(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options)"
name: "queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options)"
nameWithType: "DocumentClient.queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options)"
summary: "Query for attachments."
parameters:
- description: "the document link."
name: "documentLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Attachment> queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options)"
desc: "Query for attachments."
returns:
description: "the feed response with the obtained attachments."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Attachment?alt=com.microsoft.azure.documentdb.Attachment&text=Attachment\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryAttachments(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryAttachments(String documentLink, String query, FeedOptions options)"
name: "queryAttachments(String documentLink, String query, FeedOptions options)"
nameWithType: "DocumentClient.queryAttachments(String documentLink, String query, FeedOptions options)"
summary: "Query for attachments."
parameters:
- description: "the document link."
name: "documentLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Attachment> queryAttachments(String documentLink, String query, FeedOptions options)"
desc: "Query for attachments."
returns:
description: "the feed response with the obtained attachments."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Attachment?alt=com.microsoft.azure.documentdb.Attachment&text=Attachment\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryCollections(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryCollections(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
name: "queryCollections(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
nameWithType: "DocumentClient.queryCollections(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
summary: "Query for document collections in a database."
parameters:
- description: "the database link."
name: "databaseLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<DocumentCollection> queryCollections(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
desc: "Query for document collections in a database."
returns:
description: "the feed response with the obtained collections."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.DocumentCollection?alt=com.microsoft.azure.documentdb.DocumentCollection&text=DocumentCollection\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryCollections(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryCollections(String databaseLink, String query, FeedOptions options)"
name: "queryCollections(String databaseLink, String query, FeedOptions options)"
nameWithType: "DocumentClient.queryCollections(String databaseLink, String query, FeedOptions options)"
summary: "Query for document collections in a database."
parameters:
- description: "the database link."
name: "databaseLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<DocumentCollection> queryCollections(String databaseLink, String query, FeedOptions options)"
desc: "Query for document collections in a database."
returns:
description: "the feed response with the obtained collections."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.DocumentCollection?alt=com.microsoft.azure.documentdb.DocumentCollection&text=DocumentCollection\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryConflicts(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
name: "queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
nameWithType: "DocumentClient.queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
summary: "Query for conflicts."
parameters:
- description: "the collection link."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Conflict> queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
desc: "Query for conflicts."
returns:
description: "the feed response of the obtained conflicts."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Conflict?alt=com.microsoft.azure.documentdb.Conflict&text=Conflict\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryConflicts(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryConflicts(String collectionLink, String query, FeedOptions options)"
name: "queryConflicts(String collectionLink, String query, FeedOptions options)"
nameWithType: "DocumentClient.queryConflicts(String collectionLink, String query, FeedOptions options)"
summary: "Query for conflicts."
parameters:
- description: "the collection link."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Conflict> queryConflicts(String collectionLink, String query, FeedOptions options)"
desc: "Query for conflicts."
returns:
description: "the feed response of the obtained conflicts."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Conflict?alt=com.microsoft.azure.documentdb.Conflict&text=Conflict\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDatabases(com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDatabases(SqlQuerySpec querySpec, FeedOptions options)"
name: "queryDatabases(SqlQuerySpec querySpec, FeedOptions options)"
nameWithType: "DocumentClient.queryDatabases(SqlQuerySpec querySpec, FeedOptions options)"
summary: "Query for databases."
parameters:
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Database> queryDatabases(SqlQuerySpec querySpec, FeedOptions options)"
desc: "Query for databases."
returns:
description: "the feed response with the obtained databases."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Database?alt=com.microsoft.azure.documentdb.Database&text=Database\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDatabases(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDatabases(String query, FeedOptions options)"
name: "queryDatabases(String query, FeedOptions options)"
nameWithType: "DocumentClient.queryDatabases(String query, FeedOptions options)"
summary: "Query for databases."
parameters:
- description: "the query."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Database> queryDatabases(String query, FeedOptions options)"
desc: "Query for databases."
returns:
description: "the feed response with the obtained databases."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Database?alt=com.microsoft.azure.documentdb.Database&text=Database\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDocumentChangeFeed(java.lang.String,com.microsoft.azure.documentdb.ChangeFeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDocumentChangeFeed(String collectionLink, ChangeFeedOptions changeFeedOptions)"
name: "queryDocumentChangeFeed(String collectionLink, ChangeFeedOptions changeFeedOptions)"
nameWithType: "DocumentClient.queryDocumentChangeFeed(String collectionLink, ChangeFeedOptions changeFeedOptions)"
summary: "Query for documents change feed in a document collection."
parameters:
- description: "the link to the parent document collection"
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the options for processing the query results feed"
name: "changeFeedOptions"
type: "<xref href=\"com.microsoft.azure.documentdb.ChangeFeedOptions?alt=com.microsoft.azure.documentdb.ChangeFeedOptions&text=ChangeFeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Document> queryDocumentChangeFeed(String collectionLink, ChangeFeedOptions changeFeedOptions)"
desc: "Query for documents change feed in a document collection.\n\nExample:\n\n```java\nString partitionKeyRangeId = \"0\"; // Use client.readPartitionKeyRanges() to obtain the ranges.\n String checkpointContinuation = null;\n ChangeFeedOptions options = new ChangeFeedOptions();\n options.setPartitionKeyRangeId(partitionKeyRangeId);\n options.setRequestContinuation(checkpointContinuation);\n options.setStartFromBeginning(true);\n FeedResponse<Document> query = client.queryDocumentChangeFeed(coll.getSelfLink(), options);\n do {\n List<Document> docs = query.getQueryIterable().fetchNextBlock();\n // Process the documents\n // Checkpoint query.getResponseContinuation()\n } while (query.getQueryIterator().hasNext());\n```"
returns:
description: "the feed response with the obtained documents"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
name: "queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
nameWithType: "DocumentClient.queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
summary: "Query for documents in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Document> queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
desc: "Query for documents in a document collection."
returns:
description: "the feed response with the obtained documents."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions,java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options, Object partitionKey)"
name: "queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options, Object partitionKey)"
nameWithType: "DocumentClient.queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options, Object partitionKey)"
summary: "Query for documents in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the SQL query specification."
name: "querySpec"
type: "<xref href=\"com.microsoft.azure.documentdb.SqlQuerySpec?alt=com.microsoft.azure.documentdb.SqlQuerySpec&text=SqlQuerySpec\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "the partitionKey."
name: "partitionKey"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Document> queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options, Object partitionKey)"
desc: "Query for documents in a document collection."
returns:
description: "the feed response with the obtained documents."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(String collectionLink, String query, FeedOptions options)"
name: "queryDocuments(String collectionLink, String query, FeedOptions options)"
nameWithType: "DocumentClient.queryDocuments(String collectionLink, String query, FeedOptions options)"
summary: "Query for documents in a document collection."
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"
type: "<xref href=\"com.microsoft.azure.documentdb.FeedOptions?alt=com.microsoft.azure.documentdb.FeedOptions&text=FeedOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedResponse<Document> queryDocuments(String collectionLink, String query, FeedOptions options)"
desc: "Query for documents in a document collection."
returns:
description: "the feed response with the obtained documents."
type: "<xref href=\"com.microsoft.azure.documentdb.FeedResponse?alt=com.microsoft.azure.documentdb.FeedResponse&text=FeedResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions,java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryDocuments(String collectionLink, String query, FeedOptions options, Object partitionKey)"
name: "queryDocuments(String collectionLink, String query, FeedOptions options, Object partitionKey)"
nameWithType: "DocumentClient.queryDocuments(String collectionLink, String query, FeedOptions options, Object partitionKey)"
summary: "Query for documents in a document collection with a partition<wbr>Key"
parameters:
- description: "the link to the parent document collection."
name: "collectionLink"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the query."
name: "query"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the feed options."
name: "options"