2143 строки
188 KiB
YAML
2143 строки
188 KiB
YAML
### 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"
|
|
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, String query, FeedOptions options, Object partitionKey)"
|
|
desc: "Query for documents in a document collection with a partitionKey"
|
|
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.queryOffers(com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryOffers(SqlQuerySpec querySpec, FeedOptions options)"
|
|
name: "queryOffers(SqlQuerySpec querySpec, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryOffers(SqlQuerySpec querySpec, FeedOptions options)"
|
|
summary: "Query for offers in a database."
|
|
parameters:
|
|
- description: "the 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<Offer> queryOffers(SqlQuerySpec querySpec, FeedOptions options)"
|
|
desc: "Query for offers in a database."
|
|
returns:
|
|
description: "the feed response with the obtained offers."
|
|
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.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryOffers(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryOffers(String query, FeedOptions options)"
|
|
name: "queryOffers(String query, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryOffers(String query, FeedOptions options)"
|
|
summary: "Query for offers in a database."
|
|
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<Offer> queryOffers(String query, FeedOptions options)"
|
|
desc: "Query for offers in a database."
|
|
returns:
|
|
description: "the feed response with the obtained offers."
|
|
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.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryPermissions(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryPermissions(String permissionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
name: "queryPermissions(String permissionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryPermissions(String permissionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
summary: "Query for permissions."
|
|
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 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<Permission> queryPermissions(String permissionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
desc: "Query for permissions."
|
|
returns:
|
|
description: "the feed response with the obtained permissions."
|
|
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.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryPermissions(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryPermissions(String userLink, String query, FeedOptions options)"
|
|
name: "queryPermissions(String userLink, String query, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryPermissions(String userLink, String query, FeedOptions options)"
|
|
summary: "Query for permissions."
|
|
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 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<Permission> queryPermissions(String userLink, String query, FeedOptions options)"
|
|
desc: "Query for permissions."
|
|
returns:
|
|
description: "the feed response with the obtained permissions."
|
|
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.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryStoredProcedures(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryStoredProcedures(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
name: "queryStoredProcedures(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryStoredProcedures(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
summary: "Query for stored procedures in a document collection."
|
|
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<StoredProcedure> queryStoredProcedures(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
desc: "Query for stored procedures in a document collection."
|
|
returns:
|
|
description: "the feed response with the obtained stored procedures."
|
|
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.StoredProcedure?alt=com.microsoft.azure.documentdb.StoredProcedure&text=StoredProcedure\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryStoredProcedures(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryStoredProcedures(String collectionLink, String query, FeedOptions options)"
|
|
name: "queryStoredProcedures(String collectionLink, String query, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryStoredProcedures(String collectionLink, String query, FeedOptions options)"
|
|
summary: "Query for stored procedures in a document collection."
|
|
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<StoredProcedure> queryStoredProcedures(String collectionLink, String query, FeedOptions options)"
|
|
desc: "Query for stored procedures in a document collection."
|
|
returns:
|
|
description: "the feed response with the obtained stored procedures."
|
|
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.StoredProcedure?alt=com.microsoft.azure.documentdb.StoredProcedure&text=StoredProcedure\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryTriggers(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryTriggers(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
name: "queryTriggers(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryTriggers(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
summary: "Query for triggers."
|
|
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<Trigger> queryTriggers(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
desc: "Query for triggers."
|
|
returns:
|
|
description: "the feed response with the obtained triggers."
|
|
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.Trigger?alt=com.microsoft.azure.documentdb.Trigger&text=Trigger\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryTriggers(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryTriggers(String collectionLink, String query, FeedOptions options)"
|
|
name: "queryTriggers(String collectionLink, String query, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryTriggers(String collectionLink, String query, FeedOptions options)"
|
|
summary: "Query for triggers."
|
|
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<Trigger> queryTriggers(String collectionLink, String query, FeedOptions options)"
|
|
desc: "Query for triggers."
|
|
returns:
|
|
description: "the feed response with the obtained triggers."
|
|
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.Trigger?alt=com.microsoft.azure.documentdb.Trigger&text=Trigger\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryUserDefinedFunctions(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryUserDefinedFunctions(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
name: "queryUserDefinedFunctions(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryUserDefinedFunctions(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
summary: "Query for user defined functions."
|
|
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<UserDefinedFunction> queryUserDefinedFunctions(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
desc: "Query for user defined functions."
|
|
returns:
|
|
description: "the feed response with the obtained user defined functions."
|
|
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.UserDefinedFunction?alt=com.microsoft.azure.documentdb.UserDefinedFunction&text=UserDefinedFunction\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryUserDefinedFunctions(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryUserDefinedFunctions(String collectionLink, String query, FeedOptions options)"
|
|
name: "queryUserDefinedFunctions(String collectionLink, String query, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryUserDefinedFunctions(String collectionLink, String query, FeedOptions options)"
|
|
summary: "Query for user defined functions."
|
|
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<UserDefinedFunction> queryUserDefinedFunctions(String collectionLink, String query, FeedOptions options)"
|
|
desc: "Query for user defined functions."
|
|
returns:
|
|
description: "the feed response with the obtained user defined functions."
|
|
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.UserDefinedFunction?alt=com.microsoft.azure.documentdb.UserDefinedFunction&text=UserDefinedFunction\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryUsers(java.lang.String,com.microsoft.azure.documentdb.SqlQuerySpec,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
name: "queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
summary: "Query for users."
|
|
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<User> queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)"
|
|
desc: "Query for users."
|
|
returns:
|
|
description: "the feed response of the obtained users."
|
|
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.User?alt=com.microsoft.azure.documentdb.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.queryUsers(java.lang.String,java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.queryUsers(String databaseLink, String query, FeedOptions options)"
|
|
name: "queryUsers(String databaseLink, String query, FeedOptions options)"
|
|
nameWithType: "DocumentClient.queryUsers(String databaseLink, String query, FeedOptions options)"
|
|
summary: "Query for users."
|
|
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<User> queryUsers(String databaseLink, String query, FeedOptions options)"
|
|
desc: "Query for users."
|
|
returns:
|
|
description: "the feed response of the obtained users."
|
|
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.User?alt=com.microsoft.azure.documentdb.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readAttachment(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readAttachment(String attachmentLink, RequestOptions options)"
|
|
name: "readAttachment(String attachmentLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readAttachment(String attachmentLink, RequestOptions options)"
|
|
summary: "Reads 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> readAttachment(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: "Reads an attachment."
|
|
returns:
|
|
description: "the resource response with the read 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.readAttachments(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readAttachments(String documentLink, FeedOptions options)"
|
|
name: "readAttachments(String documentLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readAttachments(String documentLink, FeedOptions options)"
|
|
summary: "Reads all attachments in a document."
|
|
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 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> readAttachments(String documentLink, FeedOptions options)"
|
|
desc: "Reads all attachments in a document."
|
|
returns:
|
|
description: "the feed response with the read 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.readCollection(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readCollection(String collectionLink, RequestOptions options)"
|
|
name: "readCollection(String collectionLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readCollection(String collectionLink, RequestOptions options)"
|
|
summary: "Reads 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> readCollection(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: "Reads a document collection by the collection link."
|
|
returns:
|
|
description: "the resource response with the read 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.readCollections(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readCollections(String databaseLink, FeedOptions options)"
|
|
name: "readCollections(String databaseLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readCollections(String databaseLink, FeedOptions options)"
|
|
summary: "Reads all 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 fee 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> readCollections(String databaseLink, FeedOptions options)"
|
|
desc: "Reads all document collections in a database."
|
|
returns:
|
|
description: "the feed response with the read 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.readConflict(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readConflict(String conflictLink, RequestOptions options)"
|
|
name: "readConflict(String conflictLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readConflict(String conflictLink, RequestOptions options)"
|
|
summary: "Reads 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> readConflict(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: "Reads a conflict."
|
|
returns:
|
|
description: "the resource response with the read conflict."
|
|
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.readConflicts(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readConflicts(String collectionLink, FeedOptions options)"
|
|
name: "readConflicts(String collectionLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readConflicts(String collectionLink, FeedOptions options)"
|
|
summary: "Reads all conflicts in a document collection."
|
|
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 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> readConflicts(String collectionLink, FeedOptions options)"
|
|
desc: "Reads all conflicts in a document collection."
|
|
returns:
|
|
description: "the feed response with the read 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.readDatabase(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readDatabase(String databaseLink, RequestOptions options)"
|
|
name: "readDatabase(String databaseLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readDatabase(String databaseLink, RequestOptions options)"
|
|
summary: "Reads 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> readDatabase(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: "Reads a database."
|
|
returns:
|
|
description: "the resource response with the read 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.readDatabases(com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readDatabases(FeedOptions options)"
|
|
name: "readDatabases(FeedOptions options)"
|
|
nameWithType: "DocumentClient.readDatabases(FeedOptions options)"
|
|
summary: "Reads all databases."
|
|
parameters:
|
|
- 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> readDatabases(FeedOptions options)"
|
|
desc: "Reads all databases."
|
|
returns:
|
|
description: "the feed response with the read 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.readDocument(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readDocument(String documentLink, RequestOptions options)"
|
|
name: "readDocument(String documentLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readDocument(String documentLink, RequestOptions options)"
|
|
summary: "Reads 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> readDocument(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: "Reads a document by the document link."
|
|
returns:
|
|
description: "the resource response with the read 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.readDocuments(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readDocuments(String collectionLink, FeedOptions options)"
|
|
name: "readDocuments(String collectionLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readDocuments(String collectionLink, FeedOptions options)"
|
|
summary: "Reads all documents in a document collection."
|
|
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 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> readDocuments(String collectionLink, FeedOptions options)"
|
|
desc: "Reads all documents in a document collection."
|
|
returns:
|
|
description: "the feed response with read 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.readMedia(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readMedia(String mediaLink)"
|
|
name: "readMedia(String mediaLink)"
|
|
nameWithType: "DocumentClient.readMedia(String mediaLink)"
|
|
summary: "Reads a media by the media link."
|
|
parameters:
|
|
- description: "the media link."
|
|
name: "mediaLink"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MediaResponse readMedia(String mediaLink)"
|
|
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: "Reads a media by the media link."
|
|
returns:
|
|
description: "the media response."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.MediaResponse?alt=com.microsoft.azure.documentdb.MediaResponse&text=MediaResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readOffer(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readOffer(String offerLink)"
|
|
name: "readOffer(String offerLink)"
|
|
nameWithType: "DocumentClient.readOffer(String offerLink)"
|
|
summary: "Reads an offer."
|
|
parameters:
|
|
- description: "the offer link."
|
|
name: "offerLink"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ResourceResponse<Offer> readOffer(String offerLink)"
|
|
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: "Reads an offer."
|
|
returns:
|
|
description: "the resource response with the read offer."
|
|
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.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readOffers(com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readOffers(FeedOptions options)"
|
|
name: "readOffers(FeedOptions options)"
|
|
nameWithType: "DocumentClient.readOffers(FeedOptions options)"
|
|
summary: "Reads offers."
|
|
parameters:
|
|
- 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<Offer> readOffers(FeedOptions options)"
|
|
desc: "Reads offers."
|
|
returns:
|
|
description: "the feed response with the read offers."
|
|
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.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readPartitionKeyRanges(com.microsoft.azure.documentdb.DocumentCollection,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readPartitionKeyRanges(DocumentCollection documentCollection, FeedOptions options)"
|
|
name: "readPartitionKeyRanges(DocumentCollection documentCollection, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readPartitionKeyRanges(DocumentCollection documentCollection, FeedOptions options)"
|
|
summary: "Reads all partition key ranges in a document collection."
|
|
parameters:
|
|
- description: "the document collection."
|
|
name: "documentCollection"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentCollection?alt=com.microsoft.azure.documentdb.DocumentCollection&text=DocumentCollection\" 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<PartitionKeyRange> readPartitionKeyRanges(DocumentCollection documentCollection, FeedOptions options)"
|
|
desc: "Reads all partition key ranges in a document collection.\n\nExample:\n\n```java\nFeedResponse<PartitionKeyRange> partitionKeyRanges = this.client.readPartitionKeyRanges(coll, null);\n List<String> ids = new ArrayList<String>();\n for (PartitionKeyRange range : partitionKeyRanges.getQueryIterable()) {\n ids.add(range.getId());\n }\n```"
|
|
returns:
|
|
description: "the feed response with the read partition key ranges."
|
|
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.PartitionKeyRange?alt=com.microsoft.azure.documentdb.PartitionKeyRange&text=PartitionKeyRange\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readPartitionKeyRanges(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readPartitionKeyRanges(String collectionLink, FeedOptions options)"
|
|
name: "readPartitionKeyRanges(String collectionLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readPartitionKeyRanges(String collectionLink, FeedOptions options)"
|
|
summary: "Reads all partition key ranges in a document collection."
|
|
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 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<PartitionKeyRange> readPartitionKeyRanges(String collectionLink, FeedOptions options)"
|
|
desc: "Reads all partition key ranges in a document collection.\n\nExample:\n\n```java\nFeedResponse<PartitionKeyRange> partitionKeyRanges = this.client.readPartitionKeyRanges(coll, null);\n List<String> ids = new ArrayList<String>();\n for (PartitionKeyRange range : partitionKeyRanges.getQueryIterable()) {\n ids.add(range.getId());\n }\n```"
|
|
returns:
|
|
description: "the feed response with the read partition key ranges."
|
|
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.PartitionKeyRange?alt=com.microsoft.azure.documentdb.PartitionKeyRange&text=PartitionKeyRange\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readPartitionKeyRanges(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readPartitionKeyRanges(String collectionLink, String query)"
|
|
name: "readPartitionKeyRanges(String collectionLink, String query)"
|
|
nameWithType: "DocumentClient.readPartitionKeyRanges(String collectionLink, String query)"
|
|
summary: "Reads all partition key ranges in a document collection for a provided query."
|
|
parameters:
|
|
- description: "the document 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 string"
|
|
name: "query"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Collection<PartitionKeyRange> readPartitionKeyRanges(String collectionLink, String query)"
|
|
exceptions:
|
|
- description: "from partition key ranges query"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Reads all partition key ranges in a document collection for a provided query."
|
|
returns:
|
|
description: "the list of the serving partition key ranges for the query"
|
|
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.PartitionKeyRange?alt=com.microsoft.azure.documentdb.PartitionKeyRange&text=PartitionKeyRange\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readPermission(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readPermission(String permissionLink, RequestOptions options)"
|
|
name: "readPermission(String permissionLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readPermission(String permissionLink, RequestOptions options)"
|
|
summary: "Reads 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> readPermission(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: "Reads a permission."
|
|
returns:
|
|
description: "the resource response with the read 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.readPermissions(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readPermissions(String userLink, FeedOptions options)"
|
|
name: "readPermissions(String userLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readPermissions(String userLink, FeedOptions options)"
|
|
summary: "Reads all permissions."
|
|
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 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<Permission> readPermissions(String userLink, FeedOptions options)"
|
|
desc: "Reads all permissions."
|
|
returns:
|
|
description: "the feed response with the read permissions."
|
|
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.Permission?alt=com.microsoft.azure.documentdb.Permission&text=Permission\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readStoredProcedure(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readStoredProcedure(String storedProcedureLink, RequestOptions options)"
|
|
name: "readStoredProcedure(String storedProcedureLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readStoredProcedure(String storedProcedureLink, RequestOptions options)"
|
|
summary: "Read 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> readStoredProcedure(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: "Read a stored procedure by the stored procedure link."
|
|
returns:
|
|
description: "the resource response with the read 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.readStoredProcedures(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readStoredProcedures(String collectionLink, FeedOptions options)"
|
|
name: "readStoredProcedures(String collectionLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readStoredProcedures(String collectionLink, FeedOptions options)"
|
|
summary: "Reads all stored procedures in a document 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 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<StoredProcedure> readStoredProcedures(String collectionLink, FeedOptions options)"
|
|
desc: "Reads all stored procedures in a document collection link."
|
|
returns:
|
|
description: "the feed response with the read stored procedure."
|
|
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.StoredProcedure?alt=com.microsoft.azure.documentdb.StoredProcedure&text=StoredProcedure\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readTrigger(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readTrigger(String triggerLink, RequestOptions options)"
|
|
name: "readTrigger(String triggerLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readTrigger(String triggerLink, RequestOptions options)"
|
|
summary: "Reads a trigger by the trigger link."
|
|
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> readTrigger(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: "Reads a trigger by the trigger link."
|
|
returns:
|
|
description: "the resource response with the read 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.readTriggers(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readTriggers(String collectionLink, FeedOptions options)"
|
|
name: "readTriggers(String collectionLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readTriggers(String collectionLink, FeedOptions options)"
|
|
summary: "Reads all triggers in a document collection."
|
|
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 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<Trigger> readTriggers(String collectionLink, FeedOptions options)"
|
|
desc: "Reads all triggers in a document collection."
|
|
returns:
|
|
description: "the feed response with the read triggers."
|
|
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.Trigger?alt=com.microsoft.azure.documentdb.Trigger&text=Trigger\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readUser(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readUser(String userLink, RequestOptions options)"
|
|
name: "readUser(String userLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readUser(String userLink, RequestOptions options)"
|
|
summary: "Reads 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> readUser(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: "Reads a user."
|
|
returns:
|
|
description: "the resource response with the read 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.readUserDefinedFunction(java.lang.String,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readUserDefinedFunction(String udfLink, RequestOptions options)"
|
|
name: "readUserDefinedFunction(String udfLink, RequestOptions options)"
|
|
nameWithType: "DocumentClient.readUserDefinedFunction(String udfLink, RequestOptions options)"
|
|
summary: "Read 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> readUserDefinedFunction(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: "Read a user defined function."
|
|
returns:
|
|
description: "the resource response with the read 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.readUserDefinedFunctions(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readUserDefinedFunctions(String collectionLink, FeedOptions options)"
|
|
name: "readUserDefinedFunctions(String collectionLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readUserDefinedFunctions(String collectionLink, FeedOptions options)"
|
|
summary: "Reads all user defined functions in a document collection."
|
|
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 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<UserDefinedFunction> readUserDefinedFunctions(String collectionLink, FeedOptions options)"
|
|
desc: "Reads all user defined functions in a document collection."
|
|
returns:
|
|
description: "the feed response with the read user defined functions."
|
|
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.UserDefinedFunction?alt=com.microsoft.azure.documentdb.UserDefinedFunction&text=UserDefinedFunction\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.readUsers(java.lang.String,com.microsoft.azure.documentdb.FeedOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.readUsers(String databaseLink, FeedOptions options)"
|
|
name: "readUsers(String databaseLink, FeedOptions options)"
|
|
nameWithType: "DocumentClient.readUsers(String databaseLink, FeedOptions options)"
|
|
summary: "Reads all users 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 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<User> readUsers(String databaseLink, FeedOptions options)"
|
|
desc: "Reads all users in a database."
|
|
returns:
|
|
description: "the feed response with the read users."
|
|
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.User?alt=com.microsoft.azure.documentdb.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.registerPartitionResolver(java.lang.String,com.microsoft.azure.documentdb.PartitionResolver)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.registerPartitionResolver(String databaseLink, PartitionResolver partitionResolver)"
|
|
name: "registerPartitionResolver(String databaseLink, PartitionResolver partitionResolver)"
|
|
nameWithType: "DocumentClient.registerPartitionResolver(String databaseLink, PartitionResolver partitionResolver)"
|
|
parameters:
|
|
- name: "databaseLink"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "partitionResolver"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionResolver?alt=com.microsoft.azure.documentdb.PartitionResolver&text=PartitionResolver\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "</br>public void registerPartitionResolver(String databaseLink, PartitionResolver partitionResolver)"
|
|
exceptions:
|
|
- type: "<xref href=\"com.microsoft.azure.documentdb.DocumentClientException?alt=com.microsoft.azure.documentdb.DocumentClientException&text=DocumentClientException\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.replaceAttachment(com.microsoft.azure.documentdb.Attachment,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceAttachment(Attachment attachment, RequestOptions options)"
|
|
name: "replaceAttachment(Attachment attachment, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceAttachment(Attachment attachment, RequestOptions options)"
|
|
summary: "Replaces an attachment."
|
|
parameters:
|
|
- description: "the attachment to use."
|
|
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> replaceAttachment(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: "Replaces an attachment."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceCollection(com.microsoft.azure.documentdb.DocumentCollection,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceCollection(DocumentCollection collection, RequestOptions options)"
|
|
name: "replaceCollection(DocumentCollection collection, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceCollection(DocumentCollection collection, RequestOptions options)"
|
|
summary: "Replaces a document collection."
|
|
parameters:
|
|
- description: "the document collection to use."
|
|
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> replaceCollection(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: "Replaces a document collection."
|
|
returns:
|
|
description: "the resource response with the replaced document 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.replaceDocument(com.microsoft.azure.documentdb.Document,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceDocument(Document document, RequestOptions options)"
|
|
name: "replaceDocument(Document document, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceDocument(Document document, RequestOptions options)"
|
|
summary: "Replaces a document with the passed in document."
|
|
parameters:
|
|
- description: "the document to replace (containing the document id)."
|
|
name: "document"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.Document?alt=com.microsoft.azure.documentdb.Document&text=Document\" 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> replaceDocument(Document document, 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: "Replaces a document with the passed in document."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceDocument(java.lang.String,java.lang.Object,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceDocument(String documentLink, Object document, RequestOptions options)"
|
|
name: "replaceDocument(String documentLink, Object document, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceDocument(String documentLink, Object document, RequestOptions options)"
|
|
summary: "Replaces a document using a POJO object."
|
|
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 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\" />"
|
|
syntax: "public ResourceResponse<Document> replaceDocument(String documentLink, Object document, 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: "Replaces a document using a POJO object."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceOffer(com.microsoft.azure.documentdb.Offer)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceOffer(Offer offer)"
|
|
name: "replaceOffer(Offer offer)"
|
|
nameWithType: "DocumentClient.replaceOffer(Offer offer)"
|
|
summary: "Replaces an offer."
|
|
parameters:
|
|
- description: "the offer to use."
|
|
name: "offer"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ResourceResponse<Offer> replaceOffer(Offer offer)"
|
|
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: "Replaces an offer."
|
|
returns:
|
|
description: "the resource response with the replaced offer."
|
|
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.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.replacePermission(com.microsoft.azure.documentdb.Permission,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replacePermission(Permission permission, RequestOptions options)"
|
|
name: "replacePermission(Permission permission, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replacePermission(Permission permission, RequestOptions options)"
|
|
summary: "Replaces a permission."
|
|
parameters:
|
|
- description: "the permission to use."
|
|
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> replacePermission(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: "Replaces a permission."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceStoredProcedure(com.microsoft.azure.documentdb.StoredProcedure,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceStoredProcedure(StoredProcedure storedProcedure, RequestOptions options)"
|
|
name: "replaceStoredProcedure(StoredProcedure storedProcedure, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceStoredProcedure(StoredProcedure storedProcedure, RequestOptions options)"
|
|
summary: "Replaces a stored procedure."
|
|
parameters:
|
|
- description: "the stored procedure to use."
|
|
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> replaceStoredProcedure(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: "Replaces a stored procedure."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceTrigger(com.microsoft.azure.documentdb.Trigger,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceTrigger(Trigger trigger, RequestOptions options)"
|
|
name: "replaceTrigger(Trigger trigger, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceTrigger(Trigger trigger, RequestOptions options)"
|
|
summary: "Replaces a trigger."
|
|
parameters:
|
|
- description: "the trigger to use."
|
|
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> replaceTrigger(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: "Replaces a trigger."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceUser(com.microsoft.azure.documentdb.User,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceUser(User user, RequestOptions options)"
|
|
name: "replaceUser(User user, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceUser(User user, RequestOptions options)"
|
|
summary: "Replaces a user."
|
|
parameters:
|
|
- description: "the user to use."
|
|
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> replaceUser(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: "Replaces a user."
|
|
returns:
|
|
description: "the resource response with the replaced 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.replaceUserDefinedFunction(com.microsoft.azure.documentdb.UserDefinedFunction,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.replaceUserDefinedFunction(UserDefinedFunction udf, RequestOptions options)"
|
|
name: "replaceUserDefinedFunction(UserDefinedFunction udf, RequestOptions options)"
|
|
nameWithType: "DocumentClient.replaceUserDefinedFunction(UserDefinedFunction udf, RequestOptions options)"
|
|
summary: "Replaces a user defined function."
|
|
parameters:
|
|
- 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> replaceUserDefinedFunction(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: "Replaces a user defined function."
|
|
returns:
|
|
description: "the resource response with the replaced 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.updateMedia(java.lang.String,java.io.InputStream,com.microsoft.azure.documentdb.MediaOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.updateMedia(String mediaLink, InputStream mediaStream, MediaOptions options)"
|
|
name: "updateMedia(String mediaLink, InputStream mediaStream, MediaOptions options)"
|
|
nameWithType: "DocumentClient.updateMedia(String mediaLink, InputStream mediaStream, MediaOptions options)"
|
|
summary: "Updates a media by the media link."
|
|
parameters:
|
|
- description: "the media link."
|
|
name: "mediaLink"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the media stream to upload."
|
|
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 MediaResponse updateMedia(String mediaLink, 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: "Updates a media by the media link."
|
|
returns:
|
|
description: "the media response."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.MediaResponse?alt=com.microsoft.azure.documentdb.MediaResponse&text=MediaResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentClient.upsertAttachment(java.lang.String,com.microsoft.azure.documentdb.Attachment,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertAttachment(String documentLink, Attachment attachment, RequestOptions options)"
|
|
name: "upsertAttachment(String documentLink, Attachment attachment, RequestOptions options)"
|
|
nameWithType: "DocumentClient.upsertAttachment(String documentLink, Attachment attachment, RequestOptions options)"
|
|
summary: "Upserts 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 upsert."
|
|
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> upsertAttachment(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: "Upserts an attachment."
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertAttachment(java.lang.String,java.io.InputStream,com.microsoft.azure.documentdb.MediaOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
|
|
name: "upsertAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
|
|
nameWithType: "DocumentClient.upsertAttachment(String documentLink, InputStream mediaStream, MediaOptions options)"
|
|
summary: "Upserts an attachment to the media stream"
|
|
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 upserting 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> upsertAttachment(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: "Upserts an attachment to the media stream"
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertDocument(java.lang.String,java.lang.Object,com.microsoft.azure.documentdb.RequestOptions,boolean)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
|
|
name: "upsertDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
|
|
nameWithType: "DocumentClient.upsertDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)"
|
|
summary: "Upserts 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 to upsert."
|
|
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> upsertDocument(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: "Upserts a document."
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertPermission(java.lang.String,com.microsoft.azure.documentdb.Permission,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertPermission(String userLink, Permission permission, RequestOptions options)"
|
|
name: "upsertPermission(String userLink, Permission permission, RequestOptions options)"
|
|
nameWithType: "DocumentClient.upsertPermission(String userLink, Permission permission, RequestOptions options)"
|
|
summary: "Upserts 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 upsert."
|
|
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> upsertPermission(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: "Upserts a permission."
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertStoredProcedure(java.lang.String,com.microsoft.azure.documentdb.StoredProcedure,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
|
|
name: "upsertStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
|
|
nameWithType: "DocumentClient.upsertStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)"
|
|
summary: "Upserts 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 upsert."
|
|
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> upsertStoredProcedure(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: "Upserts a stored procedure."
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertTrigger(java.lang.String,com.microsoft.azure.documentdb.Trigger,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
|
|
name: "upsertTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
|
|
nameWithType: "DocumentClient.upsertTrigger(String collectionLink, Trigger trigger, RequestOptions options)"
|
|
summary: "Upserts 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 to upsert."
|
|
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> upsertTrigger(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: "Upserts a trigger."
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertUser(java.lang.String,com.microsoft.azure.documentdb.User,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertUser(String databaseLink, User user, RequestOptions options)"
|
|
name: "upsertUser(String databaseLink, User user, RequestOptions options)"
|
|
nameWithType: "DocumentClient.upsertUser(String databaseLink, User user, RequestOptions options)"
|
|
summary: "Upserts 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 upsert."
|
|
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> upsertUser(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: "Upserts a user."
|
|
returns:
|
|
description: "the resource response with the upserted 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.upsertUserDefinedFunction(java.lang.String,com.microsoft.azure.documentdb.UserDefinedFunction,com.microsoft.azure.documentdb.RequestOptions)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentClient.upsertUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
|
|
name: "upsertUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
|
|
nameWithType: "DocumentClient.upsertUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)"
|
|
summary: "Upserts 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 to upsert."
|
|
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> upsertUserDefinedFunction(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: "Upserts a user defined function."
|
|
returns:
|
|
description: "the resource response with the upserted 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\" />>"
|
|
type: "class"
|
|
desc: "Provides a client-side logical representation of the Azure Cosmos DB service. This client is used to configure and execute requests against the service.\n\nThe service client encapsulates the endpoint and credentials used to access the Azure Cosmos DB service."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.internal.CollectionCacheInternal?alt=com.microsoft.azure.documentdb.internal.CollectionCacheInternal&text=CollectionCacheInternal\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|