DocumentClient (com.microsoft.azure:azure-documentdb 1.16.2 API)

java.lang.Object
- com.microsoft.azure.documentdb.DocumentClient

All Implemented Interfaces:

com.microsoft.azure.documentdb.internal.CollectionCacheInternal, AutoCloseable
```
public class DocumentClient
extends Object
implements AutoCloseable, com.microsoft.azure.documentdb.internal.CollectionCacheInternal
```
Provides a client-side logical representation of the Azure Cosmos DB service. This client is used to configure and execute requests against the service.
The service client encapsulates the endpoint and credentials used to access the Azure Cosmos DB service.

Field Summary

Fields
Modifier and Type Field and Description

protected static String PartitionResolverErrorMessage
Deprecated.

Fields
Modifier and Type	Field and Description
`protected static String`	`PartitionResolverErrorMessage` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)` Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint and permissions.
`DocumentClient(String serviceEndpoint, List<Permission> permissionFeed, com.fasterxml.jackson.databind.ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)` Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint and permissions.
`DocumentClient(String serviceEndpoint, String masterKey, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)` Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint and keys.
`DocumentClient(String serviceEndpoint, String masterKey, com.fasterxml.jackson.databind.ObjectMapper objectMapper, ConnectionPolicy connectionPolicy, ConsistencyLevel desiredConsistencyLevel)` Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint and keys.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Close this DocumentClient instance
`ResourceResponse<Attachment>`	`createAttachment(String documentLink, Attachment attachment, RequestOptions options)` Creates an attachment.
`ResourceResponse<Attachment>`	`createAttachment(String documentLink, InputStream mediaStream, MediaOptions options)` Creates an attachment.
`ResourceResponse<DocumentCollection>`	`createCollection(String databaseLink, DocumentCollection collection, RequestOptions options)` Creates a document collection.
`ResourceResponse<Database>`	`createDatabase(Database database, RequestOptions options)` Creates a database.
`ResourceResponse<Document>`	`createDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)` Creates a document.
`ResourceResponse<Permission>`	`createPermission(String userLink, Permission permission, RequestOptions options)` Creates a permission.
`ResourceResponse<StoredProcedure>`	`createStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)` Creates a stored procedure.
`ResourceResponse<Trigger>`	`createTrigger(String collectionLink, Trigger trigger, RequestOptions options)` Creates a trigger.
`ResourceResponse<User>`	`createUser(String databaseLink, User user, RequestOptions options)` Creates a user.
`ResourceResponse<UserDefinedFunction>`	`createUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)` Creates a user defined function.
`ResourceResponse<Attachment>`	`deleteAttachment(String attachmentLink, RequestOptions options)` Deletes an attachment.
`ResourceResponse<DocumentCollection>`	`deleteCollection(String collectionLink, RequestOptions options)` Deletes a document collection by the collection link.
`ResourceResponse<Conflict>`	`deleteConflict(String conflictLink, RequestOptions options)` Deletes a conflict.
`ResourceResponse<Database>`	`deleteDatabase(String databaseLink, RequestOptions options)` Deletes a database.
`ResourceResponse<Document>`	`deleteDocument(String documentLink, RequestOptions options)` Deletes a document by the document link.
`ResourceResponse<Permission>`	`deletePermission(String permissionLink, RequestOptions options)` Deletes a permission.
`ResourceResponse<StoredProcedure>`	`deleteStoredProcedure(String storedProcedureLink, RequestOptions options)` Deletes a stored procedure by the stored procedure link.
`ResourceResponse<Trigger>`	`deleteTrigger(String triggerLink, RequestOptions options)` Deletes a trigger.
`ResourceResponse<User>`	`deleteUser(String userLink, RequestOptions options)` Deletes a user.
`ResourceResponse<UserDefinedFunction>`	`deleteUserDefinedFunction(String udfLink, RequestOptions options)` Deletes a user defined function.
`StoredProcedureResponse`	`executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)` Executes a stored procedure by the stored procedure link.
`StoredProcedureResponse`	`executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)` Executes a stored procedure by the stored procedure link.
`ConnectionPolicy`	`getConnectionPolicy()`
`DatabaseAccount`	`getDatabaseAccount()` Gets database account information.
`protected PartitionResolver`	`getPartitionResolver(String databaseLink)` Deprecated.
`URI`	`getReadEndpoint()` Gets the current read endpoint chosen based on availability and preference.
`URI`	`getServiceEndpoint()` Gets the default service endpoint as passed in by the user during construction.
`URI`	`getWriteEndpoint()` Gets the current write endpoint chosen based on availability and preference.
`List<Object>`	`queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions)` Query for aggregation values in a document collection.
`List<Object>`	`queryAggregateValues(String collectionLink, SqlQuerySpec querySpec, FeedOptions feedOptions, Object partitionKey)` Query for aggregation values in a document collection.
`List<Object>`	`queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions)` Query for aggregation values in a document collection.
`List<Object>`	`queryAggregateValues(String collectionLink, String query, FeedOptions feedOptions, String partitionKey)` Query for aggregation values in a document collection.
`FeedResponse<Attachment>`	`queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options)` Query for attachments.
`FeedResponse<Attachment>`	`queryAttachments(String documentLink, String query, FeedOptions options)` Query for attachments.
`FeedResponse<DocumentCollection>`	`queryCollections(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)` Query for document collections in a database.
`FeedResponse<DocumentCollection>`	`queryCollections(String databaseLink, String query, FeedOptions options)` Query for document collections in a database.
`FeedResponse<Conflict>`	`queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)` Query for conflicts.
`FeedResponse<Conflict>`	`queryConflicts(String collectionLink, String query, FeedOptions options)` Query for conflicts.
`FeedResponse<Database>`	`queryDatabases(SqlQuerySpec querySpec, FeedOptions options)` Query for databases.
`FeedResponse<Database>`	`queryDatabases(String query, FeedOptions options)` Query for databases.
`FeedResponse<Document>`	`queryDocumentChangeFeed(String collectionLink, ChangeFeedOptions changeFeedOptions)` Query for documents change feed in a document collection.
`FeedResponse<Document>`	`queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)` Query for documents in a document collection.
`FeedResponse<Document>`	`queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options, Object partitionKey)` Query for documents in a document collection.
`FeedResponse<Document>`	`queryDocuments(String collectionLink, String query, FeedOptions options)` Query for documents in a document collection.
`FeedResponse<Document>`	`queryDocuments(String collectionLink, String query, FeedOptions options, Object partitionKey)` Query for documents in a document collection with a partitionKey
`FeedResponse<Offer>`	`queryOffers(SqlQuerySpec querySpec, FeedOptions options)` Query for offers in a database.
`FeedResponse<Offer>`	`queryOffers(String query, FeedOptions options)` Query for offers in a database.
`FeedResponse<Permission>`	`queryPermissions(String permissionLink, SqlQuerySpec querySpec, FeedOptions options)` Query for permissions.
`FeedResponse<Permission>`	`queryPermissions(String userLink, String query, FeedOptions options)` Query for permissions.
`FeedResponse<StoredProcedure>`	`queryStoredProcedures(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)` Query for stored procedures in a document collection.
`FeedResponse<StoredProcedure>`	`queryStoredProcedures(String collectionLink, String query, FeedOptions options)` Query for stored procedures in a document collection.
`FeedResponse<Trigger>`	`queryTriggers(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)` Query for triggers.
`FeedResponse<Trigger>`	`queryTriggers(String collectionLink, String query, FeedOptions options)` Query for triggers.
`FeedResponse<UserDefinedFunction>`	`queryUserDefinedFunctions(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)` Query for user defined functions.
`FeedResponse<UserDefinedFunction>`	`queryUserDefinedFunctions(String collectionLink, String query, FeedOptions options)` Query for user defined functions.
`FeedResponse<User>`	`queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)` Query for users.
`FeedResponse<User>`	`queryUsers(String databaseLink, String query, FeedOptions options)` Query for users.
`ResourceResponse<Attachment>`	`readAttachment(String attachmentLink, RequestOptions options)` Reads an attachment.
`FeedResponse<Attachment>`	`readAttachments(String documentLink, FeedOptions options)` Reads all attachments in a document.
`ResourceResponse<DocumentCollection>`	`readCollection(String collectionLink, RequestOptions options)` Reads a document collection by the collection link.
`FeedResponse<DocumentCollection>`	`readCollections(String databaseLink, FeedOptions options)` Reads all document collections in a database.
`ResourceResponse<Conflict>`	`readConflict(String conflictLink, RequestOptions options)` Reads a conflict.
`FeedResponse<Conflict>`	`readConflicts(String collectionLink, FeedOptions options)` Reads all conflicts in a document collection.
`ResourceResponse<Database>`	`readDatabase(String databaseLink, RequestOptions options)` Reads a database.
`FeedResponse<Database>`	`readDatabases(FeedOptions options)` Reads all databases.
`ResourceResponse<Document>`	`readDocument(String documentLink, RequestOptions options)` Reads a document by the document link.
`FeedResponse<Document>`	`readDocuments(String collectionLink, FeedOptions options)` Reads all documents in a document collection.
`MediaResponse`	`readMedia(String mediaLink)` Reads a media by the media link.
`ResourceResponse<Offer>`	`readOffer(String offerLink)` Reads an offer.
`FeedResponse<Offer>`	`readOffers(FeedOptions options)` Reads offers.
`FeedResponse<PartitionKeyRange>`	`readPartitionKeyRanges(DocumentCollection documentCollection, FeedOptions options)` Reads all partition key ranges in a document collection.
`FeedResponse<PartitionKeyRange>`	`readPartitionKeyRanges(String collectionLink, FeedOptions options)` Reads all partition key ranges in a document collection.
`Collection<PartitionKeyRange>`	`readPartitionKeyRanges(String collectionLink, String query)` Reads all partition key ranges in a document collection for a provided query.
`ResourceResponse<Permission>`	`readPermission(String permissionLink, RequestOptions options)` Reads a permission.
`FeedResponse<Permission>`	`readPermissions(String userLink, FeedOptions options)` Reads all permissions.
`ResourceResponse<StoredProcedure>`	`readStoredProcedure(String storedProcedureLink, RequestOptions options)` Read a stored procedure by the stored procedure link.
`FeedResponse<StoredProcedure>`	`readStoredProcedures(String collectionLink, FeedOptions options)` Reads all stored procedures in a document collection link.
`ResourceResponse<Trigger>`	`readTrigger(String triggerLink, RequestOptions options)` Reads a trigger by the trigger link.
`FeedResponse<Trigger>`	`readTriggers(String collectionLink, FeedOptions options)` Reads all triggers in a document collection.
`ResourceResponse<User>`	`readUser(String userLink, RequestOptions options)` Reads a user.
`ResourceResponse<UserDefinedFunction>`	`readUserDefinedFunction(String udfLink, RequestOptions options)` Read a user defined function.
`FeedResponse<UserDefinedFunction>`	`readUserDefinedFunctions(String collectionLink, FeedOptions options)` Reads all user defined functions in a document collection.
`FeedResponse<User>`	`readUsers(String databaseLink, FeedOptions options)` Reads all users in a database.
`void`	`registerPartitionResolver(String databaseLink, PartitionResolver partitionResolver)` Deprecated.
`ResourceResponse<Attachment>`	`replaceAttachment(Attachment attachment, RequestOptions options)` Replaces an attachment.
`ResourceResponse<DocumentCollection>`	`replaceCollection(DocumentCollection collection, RequestOptions options)` Replaces a document collection.
`ResourceResponse<Document>`	`replaceDocument(Document document, RequestOptions options)` Replaces a document with the passed in document.
`ResourceResponse<Document>`	`replaceDocument(String documentLink, Object document, RequestOptions options)` Replaces a document using a POJO object.
`ResourceResponse<Offer>`	`replaceOffer(Offer offer)` Replaces an offer.
`ResourceResponse<Permission>`	`replacePermission(Permission permission, RequestOptions options)` Replaces a permission.
`ResourceResponse<StoredProcedure>`	`replaceStoredProcedure(StoredProcedure storedProcedure, RequestOptions options)` Replaces a stored procedure.
`ResourceResponse<Trigger>`	`replaceTrigger(Trigger trigger, RequestOptions options)` Replaces a trigger.
`ResourceResponse<User>`	`replaceUser(User user, RequestOptions options)` Replaces a user.
`ResourceResponse<UserDefinedFunction>`	`replaceUserDefinedFunction(UserDefinedFunction udf, RequestOptions options)` Replaces a user defined function.
`MediaResponse`	`updateMedia(String mediaLink, InputStream mediaStream, MediaOptions options)` Updates a media by the media link.
`ResourceResponse<Attachment>`	`upsertAttachment(String documentLink, Attachment attachment, RequestOptions options)` Upserts an attachment.
`ResourceResponse<Attachment>`	`upsertAttachment(String documentLink, InputStream mediaStream, MediaOptions options)` Upserts an attachment to the media stream
`ResourceResponse<Document>`	`upsertDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)` Upserts a document.
`ResourceResponse<Permission>`	`upsertPermission(String userLink, Permission permission, RequestOptions options)` Upserts a permission.
`ResourceResponse<StoredProcedure>`	`upsertStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)` Upserts a stored procedure.
`ResourceResponse<Trigger>`	`upsertTrigger(String collectionLink, Trigger trigger, RequestOptions options)` Upserts a trigger.
`ResourceResponse<User>`	`upsertUser(String databaseLink, User user, RequestOptions options)` Upserts a user.
`ResourceResponse<UserDefinedFunction>`	`upsertUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)` Upserts a user defined function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- PartitionResolverErrorMessage
```
@Deprecated
protected static final String PartitionResolverErrorMessage
```
  Deprecated.
  
  See Also:
  
  Constant Field Values

Constructor Detail
- DocumentClient
```
public DocumentClient(String serviceEndpoint,
                      String masterKey,
                      ConnectionPolicy connectionPolicy,
                      ConsistencyLevel desiredConsistencyLevel)
```
  Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint and keys.
  
  Parameters:
  
  serviceEndpoint - the URI of the service end point.
  
  masterKey - the master key.
  
  connectionPolicy - the connection policy.
  
  desiredConsistencyLevel - the desired consistency level.
- DocumentClient
```
public DocumentClient(String serviceEndpoint,
                      String masterKey,
                      com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                      ConnectionPolicy connectionPolicy,
                      ConsistencyLevel desiredConsistencyLevel)
```
  Initializes a new instance of the DocumentClient class using the specified Azure Cosmos DB service endpoint and keys.
  
  Parameters:
  
  serviceEndpoint - the URI of the service end point.
  
  masterKey - the master key.
  
  objectMapper - the custom objectMapper
  
  connectionPolicy - the connection policy.
  
  desiredConsistencyLevel - the desired consistency level.
- DocumentClient
```
public DocumentClient(String serviceEndpoint,
                      List<Permission> permissionFeed,
                      ConnectionPolicy connectionPolicy,
                      ConsistencyLevel desiredConsistencyLevel)
```
  Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint and permissions.
  
  Parameters:
  
  serviceEndpoint - the URI of the service end point.
  
  permissionFeed - the permission feed.
  
  connectionPolicy - the connection policy.
  
  desiredConsistencyLevel - the desired consistency level.
- DocumentClient
```
public DocumentClient(String serviceEndpoint,
                      List<Permission> permissionFeed,
                      com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                      ConnectionPolicy connectionPolicy,
                      ConsistencyLevel desiredConsistencyLevel)
```
  Initializes a new instance of the Microsoft.Azure.Documents.Client.DocumentClient class using the specified Azure Cosmos DB service endpoint and permissions.
  
  Parameters:
  
  serviceEndpoint - the URI of the service end point.
  
  permissionFeed - the permission feed.
  
  objectMapper - the custom objectMapper
  
  connectionPolicy - the connection policy.
  
  desiredConsistencyLevel - the desired consistency level.

Method Detail

registerPartitionResolver

@Deprecated
public void registerPartitionResolver(String databaseLink,
                                                  PartitionResolver partitionResolver)
                                           throws DocumentClientException

Deprecated.

Throws:: DocumentClientException

getPartitionResolver

@Deprecated
protected PartitionResolver getPartitionResolver(String databaseLink)

Deprecated.

getServiceEndpoint
```
public URI getServiceEndpoint()
```
Gets the default service endpoint as passed in by the user during construction.

Returns:

the service endpoint URI

getWriteEndpoint
```
public URI getWriteEndpoint()
```
Gets the current write endpoint chosen based on availability and preference.

Returns:

the write endpoint URI

getReadEndpoint
```
public URI getReadEndpoint()
```
Gets the current read endpoint chosen based on availability and preference.

Returns:

the read endpoint URI

getConnectionPolicy

public ConnectionPolicy getConnectionPolicy()

createDatabase

public ResourceResponse<Database> createDatabase(Database database,
                                                 RequestOptions options)
                                          throws DocumentClientException

Creates a database.

Parameters:: database - the database.; options - the request options.
Returns:: the resource response with the created database.
Throws:: DocumentClientException - the document client exception.

deleteDatabase

public ResourceResponse<Database> deleteDatabase(String databaseLink,
                                                 RequestOptions options)
                                          throws DocumentClientException

Deletes a database.

Parameters:: databaseLink - the database link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readDatabase

public ResourceResponse<Database> readDatabase(String databaseLink,
                                               RequestOptions options)
                                        throws DocumentClientException

Reads a database.

Parameters:: databaseLink - the database link.; options - the request options.
Returns:: the resource response with the read database.
Throws:: DocumentClientException - the document client exception.

readDatabases
```
public FeedResponse<Database> readDatabases(FeedOptions options)
```
Reads all databases.

Parameters:

options - the feed options.

Returns:

the feed response with the read databases.

queryDatabases

public FeedResponse<Database> queryDatabases(String query,
                                             FeedOptions options)

Query for databases.

Parameters:: query - the query.; options - the feed options.
Returns:: the feed response with the obtained databases.

queryDatabases

public FeedResponse<Database> queryDatabases(SqlQuerySpec querySpec,
                                             FeedOptions options)

Query for databases.

Parameters:: querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained databases.

createCollection

public ResourceResponse<DocumentCollection> createCollection(String databaseLink,
                                                             DocumentCollection collection,
                                                             RequestOptions options)
                                                      throws DocumentClientException

Creates a document collection.

Parameters:: databaseLink - the database link.; collection - the collection.; options - the request options.
Returns:: the resource response with the created collection.
Throws:: DocumentClientException - the document client exception.

replaceCollection

public ResourceResponse<DocumentCollection> replaceCollection(DocumentCollection collection,
                                                              RequestOptions options)
                                                       throws DocumentClientException

Replaces a document collection.

Parameters:: collection - the document collection to use.; options - the request options.
Returns:: the resource response with the replaced document collection.
Throws:: DocumentClientException - the document client exception.

deleteCollection

public ResourceResponse<DocumentCollection> deleteCollection(String collectionLink,
                                                             RequestOptions options)
                                                      throws DocumentClientException

Deletes a document collection by the collection link.

Parameters:: collectionLink - the collection link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readCollection
```
public ResourceResponse<DocumentCollection> readCollection(String collectionLink,
                                                           RequestOptions options)
                                                    throws DocumentClientException
```
Reads a document collection by the collection link.

Specified by:

readCollection in interface com.microsoft.azure.documentdb.internal.CollectionCacheInternal

Parameters:

collectionLink - the collection link.

options - the request options.

Returns:

the resource response with the read collection.

Throws:

DocumentClientException - the document client exception.

readCollections

public FeedResponse<DocumentCollection> readCollections(String databaseLink,
                                                        FeedOptions options)

Reads all document collections in a database.

Parameters:: databaseLink - the database link.; options - the fee options.
Returns:: the feed response with the read collections.

queryCollections

public FeedResponse<DocumentCollection> queryCollections(String databaseLink,
                                                         String query,
                                                         FeedOptions options)

Query for document collections in a database.

Parameters:: databaseLink - the database link.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained collections.

queryCollections

public FeedResponse<DocumentCollection> queryCollections(String databaseLink,
                                                         SqlQuerySpec querySpec,
                                                         FeedOptions options)

Query for document collections in a database.

Parameters:: databaseLink - the database link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained collections.

createDocument

public ResourceResponse<Document> createDocument(String collectionLink,
                                                 Object document,
                                                 RequestOptions options,
                                                 boolean disableAutomaticIdGeneration)
                                          throws DocumentClientException

Creates a document.

Parameters:: collectionLink - the link to the parent document collection.; document - the document represented as a POJO or Document object.; options - the request options.; disableAutomaticIdGeneration - the flag for disabling automatic id generation.
Returns:: the resource response with the created document.
Throws:: DocumentClientException - the document client exception.

upsertDocument

public ResourceResponse<Document> upsertDocument(String collectionLink,
                                                 Object document,
                                                 RequestOptions options,
                                                 boolean disableAutomaticIdGeneration)
                                          throws DocumentClientException

Upserts a document.

Parameters:: collectionLink - the link to the parent document collection.; document - the document represented as a POJO or Document object to upsert.; options - the request options.; disableAutomaticIdGeneration - the flag for disabling automatic id generation.
Returns:: the resource response with the upserted document.
Throws:: DocumentClientException - the document client exception.

replaceDocument

public ResourceResponse<Document> replaceDocument(String documentLink,
                                                  Object document,
                                                  RequestOptions options)
                                           throws DocumentClientException

Replaces a document using a POJO object.

Parameters:: documentLink - the document link.; document - the document represented as a POJO or Document object.; options - the request options.
Returns:: the resource response with the replaced document.
Throws:: DocumentClientException - the document client exception.

replaceDocument
```
public ResourceResponse<Document> replaceDocument(Document document,
                                                  RequestOptions options)
                                           throws DocumentClientException
```
Replaces a document with the passed in document.

Parameters:

document - the document to replace (containing the document id).

options - the request options.

Returns:

the resource response with the replaced document.

Throws:

DocumentClientException - the document client exception.

deleteDocument

public ResourceResponse<Document> deleteDocument(String documentLink,
                                                 RequestOptions options)
                                          throws DocumentClientException

Deletes a document by the document link.

Parameters:: documentLink - the document link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readDocument

public ResourceResponse<Document> readDocument(String documentLink,
                                               RequestOptions options)
                                        throws DocumentClientException

Reads a document by the document link.

Parameters:: documentLink - the document link.; options - the request options.
Returns:: the resource response with the read document.
Throws:: DocumentClientException - the document client exception.

readDocuments

public FeedResponse<Document> readDocuments(String collectionLink,
                                            FeedOptions options)

Reads all documents in a document collection.

Parameters:: collectionLink - the collection link.; options - the feed options.
Returns:: the feed response with read documents.

queryDocuments

public FeedResponse<Document> queryDocuments(String collectionLink,
                                             String query,
                                             FeedOptions options)

Query for documents in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained documents.

queryDocuments

public FeedResponse<Document> queryDocuments(String collectionLink,
                                             String query,
                                             FeedOptions options,
                                             Object partitionKey)

Query for documents in a document collection with a partitionKey

Parameters:: collectionLink - the link to the parent document collection.; query - the query.; options - the feed options.; partitionKey - the partitionKey.
Returns:: the feed response with the obtained documents.

queryDocuments

public FeedResponse<Document> queryDocuments(String collectionLink,
                                             SqlQuerySpec querySpec,
                                             FeedOptions options)

Query for documents in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained documents.

queryDocuments

public FeedResponse<Document> queryDocuments(String collectionLink,
                                             SqlQuerySpec querySpec,
                                             FeedOptions options,
                                             Object partitionKey)

Query for documents in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; querySpec - the SQL query specification.; options - the feed options.; partitionKey - the partitionKey.
Returns:: the feed response with the obtained documents.

queryAggregateValues

public List<Object> queryAggregateValues(String collectionLink,
                                         String query,
                                         FeedOptions feedOptions)

Query for aggregation values in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; query - the query string.; feedOptions - the feed options.
Returns:: a list containing the aggregation values

queryAggregateValues

public List<Object> queryAggregateValues(String collectionLink,
                                         String query,
                                         FeedOptions feedOptions,
                                         String partitionKey)

Query for aggregation values in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; query - the query string.; feedOptions - the feed options.; partitionKey - the partitionKey.
Returns:: a list containing the aggregation values

queryAggregateValues

public List<Object> queryAggregateValues(String collectionLink,
                                         SqlQuerySpec querySpec,
                                         FeedOptions feedOptions)

Query for aggregation values in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; querySpec - the SQL query specification.; feedOptions - the feed options.
Returns:: a list containing the aggregation values

queryAggregateValues

public List<Object> queryAggregateValues(String collectionLink,
                                         SqlQuerySpec querySpec,
                                         FeedOptions feedOptions,
                                         Object partitionKey)

Query for aggregation values in a document collection.

Parameters:: collectionLink - the link to the parent document collection.; querySpec - the SQL query specification.; feedOptions - the feed options.; partitionKey - the partitionKey.
Returns:: a list containing the aggregation values

queryDocumentChangeFeed

public FeedResponse<Document> queryDocumentChangeFeed(String collectionLink,
                                                      ChangeFeedOptions changeFeedOptions)

Query for documents change feed in a document collection.

Example:

 String partitionKeyRangeId = "0";   // Use client.readPartitionKeyRanges() to obtain the ranges.
 String checkpointContinuation = null;
 ChangeFeedOptions options = new ChangeFeedOptions();
 options.setPartitionKeyRangeId(partitionKeyRangeId);
 options.setRequestContinuation(checkpointContinuation);
 options.setStartFromBeginning(true);
 FeedResponse<Document> query = client.queryDocumentChangeFeed(coll.getSelfLink(), options);
 do {
     List<Document> docs = query.getQueryIterable().fetchNextBlock();
     // Process the documents
     // Checkpoint query.getResponseContinuation()
 } while (query.getQueryIterator().hasNext());

Parameters:: collectionLink - the link to the parent document collection; changeFeedOptions - the options for processing the query results feed
Returns:: the feed response with the obtained documents
See Also:: ChangeFeedOptions, PartitionKeyRange

createStoredProcedure

public ResourceResponse<StoredProcedure> createStoredProcedure(String collectionLink,
                                                               StoredProcedure storedProcedure,
                                                               RequestOptions options)
                                                        throws DocumentClientException

Creates a stored procedure.

Parameters:: collectionLink - the collection link.; storedProcedure - the stored procedure to create.; options - the request options.
Returns:: the resource response with the created stored procedure.
Throws:: DocumentClientException - the document client exception.

upsertStoredProcedure

public ResourceResponse<StoredProcedure> upsertStoredProcedure(String collectionLink,
                                                               StoredProcedure storedProcedure,
                                                               RequestOptions options)
                                                        throws DocumentClientException

Upserts a stored procedure.

Parameters:: collectionLink - the collection link.; storedProcedure - the stored procedure to upsert.; options - the request options.
Returns:: the resource response with the upserted stored procedure.
Throws:: DocumentClientException - the document client exception.

replaceStoredProcedure

public ResourceResponse<StoredProcedure> replaceStoredProcedure(StoredProcedure storedProcedure,
                                                                RequestOptions options)
                                                         throws DocumentClientException

Replaces a stored procedure.

Parameters:: storedProcedure - the stored procedure to use.; options - the request options.
Returns:: the resource response with the replaced stored procedure.
Throws:: DocumentClientException - the document client exception.

deleteStoredProcedure

public ResourceResponse<StoredProcedure> deleteStoredProcedure(String storedProcedureLink,
                                                               RequestOptions options)
                                                        throws DocumentClientException

Deletes a stored procedure by the stored procedure link.

Parameters:: storedProcedureLink - the stored procedure link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readStoredProcedure

public ResourceResponse<StoredProcedure> readStoredProcedure(String storedProcedureLink,
                                                             RequestOptions options)
                                                      throws DocumentClientException

Read a stored procedure by the stored procedure link.

Parameters:: storedProcedureLink - the stored procedure link.; options - the request options.
Returns:: the resource response with the read stored procedure.
Throws:: DocumentClientException - the document client exception.

readStoredProcedures

public FeedResponse<StoredProcedure> readStoredProcedures(String collectionLink,
                                                          FeedOptions options)

Reads all stored procedures in a document collection link.

Parameters:: collectionLink - the collection link.; options - the feed options.
Returns:: the feed response with the read stored procedure.

queryStoredProcedures

public FeedResponse<StoredProcedure> queryStoredProcedures(String collectionLink,
                                                           String query,
                                                           FeedOptions options)

Query for stored procedures in a document collection.

Parameters:: collectionLink - the collection link.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained stored procedures.

queryStoredProcedures

public FeedResponse<StoredProcedure> queryStoredProcedures(String collectionLink,
                                                           SqlQuerySpec querySpec,
                                                           FeedOptions options)

Query for stored procedures in a document collection.

Parameters:: collectionLink - the collection link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained stored procedures.

executeStoredProcedure

public StoredProcedureResponse executeStoredProcedure(String storedProcedureLink,
                                                      Object[] procedureParams)
                                               throws DocumentClientException

Executes a stored procedure by the stored procedure link.

Parameters:: storedProcedureLink - the stored procedure link.; procedureParams - the array of procedure parameter values.
Returns:: the stored procedure response.
Throws:: DocumentClientException - the document client exception.

executeStoredProcedure

public StoredProcedureResponse executeStoredProcedure(String storedProcedureLink,
                                                      RequestOptions options,
                                                      Object[] procedureParams)
                                               throws DocumentClientException

Executes a stored procedure by the stored procedure link.

Parameters:: storedProcedureLink - the stored procedure link.; options - the request options.; procedureParams - the array of procedure parameter values.
Returns:: the stored procedure response.
Throws:: DocumentClientException - the document client exception.

createTrigger

public ResourceResponse<Trigger> createTrigger(String collectionLink,
                                               Trigger trigger,
                                               RequestOptions options)
                                        throws DocumentClientException

Creates a trigger.

Parameters:: collectionLink - the collection link.; trigger - the trigger.; options - the request options.
Returns:: the resource response with the created trigger.
Throws:: DocumentClientException - the document client exception.

upsertTrigger

public ResourceResponse<Trigger> upsertTrigger(String collectionLink,
                                               Trigger trigger,
                                               RequestOptions options)
                                        throws DocumentClientException

Upserts a trigger.

Parameters:: collectionLink - the collection link.; trigger - the trigger to upsert.; options - the request options.
Returns:: the resource response with the upserted trigger.
Throws:: DocumentClientException - the document client exception.

replaceTrigger

public ResourceResponse<Trigger> replaceTrigger(Trigger trigger,
                                                RequestOptions options)
                                         throws DocumentClientException

Replaces a trigger.

Parameters:: trigger - the trigger to use.; options - the request options.
Returns:: the resource response with the replaced trigger.
Throws:: DocumentClientException - the document client exception.

deleteTrigger

public ResourceResponse<Trigger> deleteTrigger(String triggerLink,
                                               RequestOptions options)
                                        throws DocumentClientException

Deletes a trigger.

Parameters:: triggerLink - the trigger link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readTrigger

public ResourceResponse<Trigger> readTrigger(String triggerLink,
                                             RequestOptions options)
                                      throws DocumentClientException

Reads a trigger by the trigger link.

Parameters:: triggerLink - the trigger link.; options - the request options.
Returns:: the resource response with the read trigger.
Throws:: DocumentClientException - the document client exception.

readTriggers

public FeedResponse<Trigger> readTriggers(String collectionLink,
                                          FeedOptions options)

Reads all triggers in a document collection.

Parameters:: collectionLink - the collection link.; options - the feed options.
Returns:: the feed response with the read triggers.

queryTriggers

public FeedResponse<Trigger> queryTriggers(String collectionLink,
                                           String query,
                                           FeedOptions options)

Query for triggers.

Parameters:: collectionLink - the collection link.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained triggers.

queryTriggers

public FeedResponse<Trigger> queryTriggers(String collectionLink,
                                           SqlQuerySpec querySpec,
                                           FeedOptions options)

Query for triggers.

Parameters:: collectionLink - the collection link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained triggers.

readPartitionKeyRanges

public FeedResponse<PartitionKeyRange> readPartitionKeyRanges(String collectionLink,
                                                              FeedOptions options)

Reads all partition key ranges in a document collection.

Example:

 FeedResponse<PartitionKeyRange> partitionKeyRanges = this.client.readPartitionKeyRanges(coll, null);
 List<String> ids = new ArrayList<String>();
 for (PartitionKeyRange range : partitionKeyRanges.getQueryIterable()) {
     ids.add(range.getId());
 }

Parameters:: collectionLink - the collection link.; options - the feed options.
Returns:: the feed response with the read partition key ranges.
See Also:: PartitionKeyRange

readPartitionKeyRanges

public FeedResponse<PartitionKeyRange> readPartitionKeyRanges(DocumentCollection documentCollection,
                                                              FeedOptions options)

Reads all partition key ranges in a document collection.

Example:

 FeedResponse<PartitionKeyRange> partitionKeyRanges = this.client.readPartitionKeyRanges(coll, null);
 List<String> ids = new ArrayList<String>();
 for (PartitionKeyRange range : partitionKeyRanges.getQueryIterable()) {
     ids.add(range.getId());
 }

Parameters:: documentCollection - the document collection.; options - the feed options.
Returns:: the feed response with the read partition key ranges.
See Also:: PartitionKeyRange

readPartitionKeyRanges

public Collection<PartitionKeyRange> readPartitionKeyRanges(String collectionLink,
                                                            String query)
                                                     throws DocumentClientException

Reads all partition key ranges in a document collection for a provided query.

Parameters:: collectionLink - the document collection link; query - the query string
Returns:: the list of the serving partition key ranges for the query
Throws:: DocumentClientException - from partition key ranges query

createUserDefinedFunction

public ResourceResponse<UserDefinedFunction> createUserDefinedFunction(String collectionLink,
                                                                       UserDefinedFunction udf,
                                                                       RequestOptions options)
                                                                throws DocumentClientException

Creates a user defined function.

Parameters:: collectionLink - the collection link.; udf - the user defined function.; options - the request options.
Returns:: the resource response with the created user defined function.
Throws:: DocumentClientException - the document client exception.

upsertUserDefinedFunction

public ResourceResponse<UserDefinedFunction> upsertUserDefinedFunction(String collectionLink,
                                                                       UserDefinedFunction udf,
                                                                       RequestOptions options)
                                                                throws DocumentClientException

Upserts a user defined function.

Parameters:: collectionLink - the collection link.; udf - the user defined function to upsert.; options - the request options.
Returns:: the resource response with the upserted user defined function.
Throws:: DocumentClientException - the document client exception.

replaceUserDefinedFunction

public ResourceResponse<UserDefinedFunction> replaceUserDefinedFunction(UserDefinedFunction udf,
                                                                        RequestOptions options)
                                                                 throws DocumentClientException

Replaces a user defined function.

Parameters:: udf - the user defined function.; options - the request options.
Returns:: the resource response with the replaced user defined function.
Throws:: DocumentClientException - the document client exception.

deleteUserDefinedFunction

public ResourceResponse<UserDefinedFunction> deleteUserDefinedFunction(String udfLink,
                                                                       RequestOptions options)
                                                                throws DocumentClientException

Deletes a user defined function.

Parameters:: udfLink - the user defined function link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readUserDefinedFunction

public ResourceResponse<UserDefinedFunction> readUserDefinedFunction(String udfLink,
                                                                     RequestOptions options)
                                                              throws DocumentClientException

Read a user defined function.

Parameters:: udfLink - the user defined function link.; options - the request options.
Returns:: the resource response with the read user defined function.
Throws:: DocumentClientException - the document client exception.

readUserDefinedFunctions

public FeedResponse<UserDefinedFunction> readUserDefinedFunctions(String collectionLink,
                                                                  FeedOptions options)

Reads all user defined functions in a document collection.

Parameters:: collectionLink - the collection link.; options - the feed options.
Returns:: the feed response with the read user defined functions.

queryUserDefinedFunctions

public FeedResponse<UserDefinedFunction> queryUserDefinedFunctions(String collectionLink,
                                                                   String query,
                                                                   FeedOptions options)

Query for user defined functions.

Parameters:: collectionLink - the collection link.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained user defined functions.

queryUserDefinedFunctions

public FeedResponse<UserDefinedFunction> queryUserDefinedFunctions(String collectionLink,
                                                                   SqlQuerySpec querySpec,
                                                                   FeedOptions options)

Query for user defined functions.

Parameters:: collectionLink - the collection link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained user defined functions.

createAttachment

public ResourceResponse<Attachment> createAttachment(String documentLink,
                                                     Attachment attachment,
                                                     RequestOptions options)
                                              throws DocumentClientException

Creates an attachment.

Parameters:: documentLink - the document link.; attachment - the attachment to create.; options - the request options.
Returns:: the resource response with the created attachment.
Throws:: DocumentClientException - the document client exception.

upsertAttachment

public ResourceResponse<Attachment> upsertAttachment(String documentLink,
                                                     Attachment attachment,
                                                     RequestOptions options)
                                              throws DocumentClientException

Upserts an attachment.

Parameters:: documentLink - the document link.; attachment - the attachment to upsert.; options - the request options.
Returns:: the resource response with the upserted attachment.
Throws:: DocumentClientException - the document client exception.

replaceAttachment

public ResourceResponse<Attachment> replaceAttachment(Attachment attachment,
                                                      RequestOptions options)
                                               throws DocumentClientException

Replaces an attachment.

Parameters:: attachment - the attachment to use.; options - the request options.
Returns:: the resource response with the replaced attachment.
Throws:: DocumentClientException - the document client exception.

deleteAttachment

public ResourceResponse<Attachment> deleteAttachment(String attachmentLink,
                                                     RequestOptions options)
                                              throws DocumentClientException

Deletes an attachment.

Parameters:: attachmentLink - the attachment link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readAttachment

public ResourceResponse<Attachment> readAttachment(String attachmentLink,
                                                   RequestOptions options)
                                            throws DocumentClientException

Reads an attachment.

Parameters:: attachmentLink - the attachment link.; options - the request options.
Returns:: the resource response with the read attachment.
Throws:: DocumentClientException - the document client exception.

readAttachments

public FeedResponse<Attachment> readAttachments(String documentLink,
                                                FeedOptions options)

Reads all attachments in a document.

Parameters:: documentLink - the document link.; options - the feed options.
Returns:: the feed response with the read attachments.

queryAttachments

public FeedResponse<Attachment> queryAttachments(String documentLink,
                                                 String query,
                                                 FeedOptions options)

Query for attachments.

Parameters:: documentLink - the document link.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained attachments.

queryAttachments

public FeedResponse<Attachment> queryAttachments(String documentLink,
                                                 SqlQuerySpec querySpec,
                                                 FeedOptions options)

Query for attachments.

Parameters:: documentLink - the document link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained attachments.

createAttachment

public ResourceResponse<Attachment> createAttachment(String documentLink,
                                                     InputStream mediaStream,
                                                     MediaOptions options)
                                              throws DocumentClientException

Creates an attachment.

Parameters:: documentLink - the document link.; mediaStream - the media stream for creating the attachment.; options - the media options.
Returns:: the resource response with the created attachment.
Throws:: DocumentClientException - the document client exception.

upsertAttachment

public ResourceResponse<Attachment> upsertAttachment(String documentLink,
                                                     InputStream mediaStream,
                                                     MediaOptions options)
                                              throws DocumentClientException

Upserts an attachment to the media stream

Parameters:: documentLink - the document link.; mediaStream - the media stream for upserting the attachment.; options - the media options.
Returns:: the resource response with the upserted attachment.
Throws:: DocumentClientException - the document client exception.

readMedia
```
public MediaResponse readMedia(String mediaLink)
                        throws DocumentClientException
```
Reads a media by the media link.

Parameters:

mediaLink - the media link.

Returns:

the media response.

Throws:

DocumentClientException - the document client exception.

updateMedia

public MediaResponse updateMedia(String mediaLink,
                                 InputStream mediaStream,
                                 MediaOptions options)
                          throws DocumentClientException

Updates a media by the media link.

Parameters:: mediaLink - the media link.; mediaStream - the media stream to upload.; options - the media options.
Returns:: the media response.
Throws:: DocumentClientException - the document client exception.

readConflict

public ResourceResponse<Conflict> readConflict(String conflictLink,
                                               RequestOptions options)
                                        throws DocumentClientException

Reads a conflict.

Parameters:: conflictLink - the conflict link.; options - the request options.
Returns:: the resource response with the read conflict.
Throws:: DocumentClientException - the document client exception.

readConflicts

public FeedResponse<Conflict> readConflicts(String collectionLink,
                                            FeedOptions options)

Reads all conflicts in a document collection.

Parameters:: collectionLink - the collection link.; options - the feed options.
Returns:: the feed response with the read conflicts.

queryConflicts

public FeedResponse<Conflict> queryConflicts(String collectionLink,
                                             String query,
                                             FeedOptions options)

Query for conflicts.

Parameters:: collectionLink - the collection link.; query - the query.; options - the feed options.
Returns:: the feed response of the obtained conflicts.

queryConflicts

public FeedResponse<Conflict> queryConflicts(String collectionLink,
                                             SqlQuerySpec querySpec,
                                             FeedOptions options)

Query for conflicts.

Parameters:: collectionLink - the collection link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response of the obtained conflicts.

deleteConflict

public ResourceResponse<Conflict> deleteConflict(String conflictLink,
                                                 RequestOptions options)
                                          throws DocumentClientException

Deletes a conflict.

Parameters:: conflictLink - the conflict link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

createUser

public ResourceResponse<User> createUser(String databaseLink,
                                         User user,
                                         RequestOptions options)
                                  throws DocumentClientException

Creates a user.

Parameters:: databaseLink - the database link.; user - the user to create.; options - the request options.
Returns:: the resource response with the created user.
Throws:: DocumentClientException - the document client exception.

upsertUser

public ResourceResponse<User> upsertUser(String databaseLink,
                                         User user,
                                         RequestOptions options)
                                  throws DocumentClientException

Upserts a user.

Parameters:: databaseLink - the database link.; user - the user to upsert.; options - the request options.
Returns:: the resource response with the upserted user.
Throws:: DocumentClientException - the document client exception.

replaceUser

public ResourceResponse<User> replaceUser(User user,
                                          RequestOptions options)
                                   throws DocumentClientException

Replaces a user.

Parameters:: user - the user to use.; options - the request options.
Returns:: the resource response with the replaced user.
Throws:: DocumentClientException - the document client exception.

deleteUser

public ResourceResponse<User> deleteUser(String userLink,
                                         RequestOptions options)
                                  throws DocumentClientException

Deletes a user.

Parameters:: userLink - the user link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readUser

public ResourceResponse<User> readUser(String userLink,
                                       RequestOptions options)
                                throws DocumentClientException

Reads a user.

Parameters:: userLink - the user link.; options - the request options.
Returns:: the resource response with the read user.
Throws:: DocumentClientException - the document client exception.

readUsers

public FeedResponse<User> readUsers(String databaseLink,
                                    FeedOptions options)

Reads all users in a database.

Parameters:: databaseLink - the database link.; options - the feed options.
Returns:: the feed response with the read users.

queryUsers

public FeedResponse<User> queryUsers(String databaseLink,
                                     String query,
                                     FeedOptions options)

Query for users.

Parameters:: databaseLink - the database link.; query - the query.; options - the feed options.
Returns:: the feed response of the obtained users.

queryUsers

public FeedResponse<User> queryUsers(String databaseLink,
                                     SqlQuerySpec querySpec,
                                     FeedOptions options)

Query for users.

Parameters:: databaseLink - the database link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response of the obtained users.

createPermission

public ResourceResponse<Permission> createPermission(String userLink,
                                                     Permission permission,
                                                     RequestOptions options)
                                              throws DocumentClientException

Creates a permission.

Parameters:: userLink - the user link.; permission - the permission to create.; options - the request options.
Returns:: the resource response with the created permission.
Throws:: DocumentClientException - the document client exception.

upsertPermission

public ResourceResponse<Permission> upsertPermission(String userLink,
                                                     Permission permission,
                                                     RequestOptions options)
                                              throws DocumentClientException

Upserts a permission.

Parameters:: userLink - the user link.; permission - the permission to upsert.; options - the request options.
Returns:: the resource response with the upserted permission.
Throws:: DocumentClientException - the document client exception.

replacePermission

public ResourceResponse<Permission> replacePermission(Permission permission,
                                                      RequestOptions options)
                                               throws DocumentClientException

Replaces a permission.

Parameters:: permission - the permission to use.; options - the request options.
Returns:: the resource response with the replaced permission.
Throws:: DocumentClientException - the document client exception.

deletePermission

public ResourceResponse<Permission> deletePermission(String permissionLink,
                                                     RequestOptions options)
                                              throws DocumentClientException

Deletes a permission.

Parameters:: permissionLink - the permission link.; options - the request options.
Returns:: the resource response.
Throws:: DocumentClientException - the document client exception.

readPermission

public ResourceResponse<Permission> readPermission(String permissionLink,
                                                   RequestOptions options)
                                            throws DocumentClientException

Reads a permission.

Parameters:: permissionLink - the permission link.; options - the request options.
Returns:: the resource response with the read permission.
Throws:: DocumentClientException - the document client exception.

readPermissions

public FeedResponse<Permission> readPermissions(String userLink,
                                                FeedOptions options)

Reads all permissions.

Parameters:: userLink - the user link.; options - the feed options.
Returns:: the feed response with the read permissions.

queryPermissions

public FeedResponse<Permission> queryPermissions(String userLink,
                                                 String query,
                                                 FeedOptions options)

Query for permissions.

Parameters:: userLink - the user link.; query - the query.; options - the feed options.
Returns:: the feed response with the obtained permissions.

queryPermissions

public FeedResponse<Permission> queryPermissions(String permissionLink,
                                                 SqlQuerySpec querySpec,
                                                 FeedOptions options)

Query for permissions.

Parameters:: permissionLink - the permission link.; querySpec - the SQL query specification.; options - the feed options.
Returns:: the feed response with the obtained permissions.

replaceOffer
```
public ResourceResponse<Offer> replaceOffer(Offer offer)
                                     throws DocumentClientException
```
Replaces an offer.

Parameters:

offer - the offer to use.

Returns:

the resource response with the replaced offer.

Throws:

DocumentClientException - the document client exception.

readOffer
```
public ResourceResponse<Offer> readOffer(String offerLink)
                                  throws DocumentClientException
```
Reads an offer.

Parameters:

offerLink - the offer link.

Returns:

the resource response with the read offer.

Throws:

DocumentClientException - the document client exception.

readOffers
```
public FeedResponse<Offer> readOffers(FeedOptions options)
```
Reads offers.

Parameters:

options - the feed options.

Returns:

the feed response with the read offers.

queryOffers

public FeedResponse<Offer> queryOffers(String query,
                                       FeedOptions options)

Query for offers in a database.

Parameters:: query - the query.; options - the feed options.
Returns:: the feed response with the obtained offers.

queryOffers

public FeedResponse<Offer> queryOffers(SqlQuerySpec querySpec,
                                       FeedOptions options)

Query for offers in a database.

Parameters:: querySpec - the query specification.; options - the feed options.
Returns:: the feed response with the obtained offers.

getDatabaseAccount
```
public DatabaseAccount getDatabaseAccount()
                                   throws DocumentClientException
```
Gets database account information.

Returns:

the database account.

Throws:

DocumentClientException - the document client exception.

close
```
public void close()
```
Close this DocumentClient instance

Specified by:

close in interface AutoCloseable

Class DocumentClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PartitionResolverErrorMessage

Constructor Detail

DocumentClient

DocumentClient

DocumentClient

DocumentClient

Method Detail

registerPartitionResolver

getPartitionResolver

getServiceEndpoint

getWriteEndpoint

getReadEndpoint

getConnectionPolicy

createDatabase

deleteDatabase

readDatabase

readDatabases

queryDatabases

queryDatabases

createCollection

replaceCollection

deleteCollection

readCollection

readCollections

queryCollections

queryCollections

createDocument

upsertDocument

replaceDocument

replaceDocument

deleteDocument

readDocument

readDocuments

queryDocuments

queryDocuments

queryDocuments

queryDocuments

queryAggregateValues

queryAggregateValues

queryAggregateValues

queryAggregateValues

queryDocumentChangeFeed

createStoredProcedure

upsertStoredProcedure

replaceStoredProcedure

deleteStoredProcedure

readStoredProcedure

readStoredProcedures

queryStoredProcedures

queryStoredProcedures

executeStoredProcedure

executeStoredProcedure

createTrigger

upsertTrigger

replaceTrigger

deleteTrigger

readTrigger

readTriggers

queryTriggers

queryTriggers

readPartitionKeyRanges

readPartitionKeyRanges

readPartitionKeyRanges

createUserDefinedFunction

upsertUserDefinedFunction

replaceUserDefinedFunction

deleteUserDefinedFunction

readUserDefinedFunction

readUserDefinedFunctions

queryUserDefinedFunctions

queryUserDefinedFunctions

createAttachment

upsertAttachment

replaceAttachment