你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
AsyncDocumentClient 接口
public interface AsyncDocumentClient
提供 Azure Cosmos DB 数据库服务的客户端逻辑表示形式。 此异步客户端用于配置和执行针对服务的请求。
AsyncDocumentClient 异步 API 返回 rxJava 的Observable
</code> , and so you can use rxJava <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Observable"></xref> functionality. <b>The async <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Observable"></xref> based APIs perform the requested operation only after subscription.</b></p>
服务客户端封装用于访问 Cosmos DB 服务的终结点和凭据。
若要实例化，可以使用 AsyncDocumentClient.Builder
ConnectionPolicy connectionPolicy = new ConnectionPolicy () ;connectionPolicy.setConnectionMode(ConnectionMode.Direct);
AsyncDocumentClient client = new AsyncDocumentClient.Builder()
.withServiceEndpoint(serviceEndpoint)
.withMasterKeyOrResourceToken(masterKey)
.withConnectionPolicy(connectionPolicy)
.withConsistencyLevel(ConsistencyLevel.Session)
.build();
</code></pre></p>
方法摘要
方法详细信息
close
public void close()
关闭此 AsyncDocumentClient 实例并清理资源。
createAttachment
public Observable> createAttachment(String documentLink, Attachment attachment, RequestOptions options)
创建附件。
订阅后，将执行该操作。 成功完成时， Observable 将包含单个资源响应以及所创建的附件。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
attachment
- 要创建的附件。
options
- 请求选项。
返回:
， Observable 包含单个资源响应以及所创建的附件或错误。
createAttachment
public Observable> createAttachment(String documentLink, InputStream mediaStream, MediaOptions options, RequestOptions requestOptions)
创建附件。
订阅后，将执行该操作。 成功完成时， Observable 将包含单个资源响应以及所创建的附件。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
mediaStream
- 用于创建附件的媒体流。
options
- 媒体选项。
requestOptions
- 请求选项
返回:
， Observable 包含单个资源响应以及所创建的附件或错误。
createCollection
public Observable> createCollection(String databaseLink, DocumentCollection collection, RequestOptions options)
创建文档集合。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有所创建集合的单个资源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
collection
- 集合。
options
- 请求选项。
返回:
， Observable 包含单个资源响应，其中包含创建的集合或错误。
createDatabase
public Observable> createDatabase(Database database, RequestOptions options)
创建数据库。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有所创建数据库的单个资源响应。 如果失败，将 Observable 出错。
参数:
database
- 数据库。
options
- 请求选项。
返回:
一个 ， Observable 包含单个资源响应，其中包含创建的数据库或错误。
createDocument
public Observable> createDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)
创建文档。
订阅后，将执行该操作。 成功完成后， Observable 将包含包含所创建文档的单个资源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 指向父文档集合的链接。
document
- 表示为 POJO 或 Document 对象的文档。
options
- 请求选项。
disableAutomaticIdGeneration
- 用于禁用自动 ID 生成的标志。
返回:
， Observable 包含单个资源响应，其中包含创建的文档或错误。
createPermission
public Observable> createPermission(String userLink, Permission permission, RequestOptions options)
创建权限。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有创建权限的单个资源响应。 如果失败，将 Observable 出错。
参数:
userLink
- 用户链接。
permission
- 要创建的权限。
options
- 请求选项。
返回:
， Observable 包含具有创建权限或错误的单个资源响应。
createStoredProcedure
public Observable> createStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)
创建存储过程。
订阅后，将执行该操作。 成功完成后， Observable 将包含单个资源响应以及所创建的存储过程。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
storedProcedure
- 要创建的存储过程。
options
- 请求选项。
返回:
包含 Observable 单个资源响应的 ，其中包含创建的存储过程或错误。
createTrigger
public Observable> createTrigger(String collectionLink, Trigger trigger, RequestOptions options)
创建触发器。
订阅后，将执行该操作。 成功完成后， Observable 将包含单个资源响应以及创建的触发器。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
trigger
- 触发器。
options
- 请求选项。
返回:
， Observable 包含具有所创建触发器或错误的单个资源响应。
createUser
public Observable> createUser(String databaseLink, User user, RequestOptions options)
创建用户。
订阅后，将执行该操作。 成功完成后， Observable 将包含创建用户的单个资源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
user
- 要创建的用户。
options
- 请求选项。
返回:
， Observable 包含单个资源响应以及创建的用户或错误。
createUserDefinedFunction
public Observable> createUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)
创建用户定义的函数。
订阅后，将执行该操作。 成功完成时， Observable 将包含单个资源响应，其中包含已创建的用户定义函数。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
udf
- 用户定义的函数。
options
- 请求选项。
返回:
包含 Observable 单个资源响应的 ，其中包含创建的用户定义函数或错误。
deleteAttachment
public Observable> deleteAttachment(String attachmentLink, RequestOptions options)
删除附件。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除附件的单个资源响应。 如果失败，将 Observable 出错。
参数:
attachmentLink
- 附件链接。
options
- 请求选项。
返回:
， Observable 包含已删除附件或错误的单个资源响应。
deleteCollection
public Observable> deleteCollection(String collectionLink, RequestOptions options)
通过集合链接删除文档集合。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除数据库的单个资源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
options
- 请求选项。
返回:
， Observable 包含已删除数据库的单个资源响应或错误。
deleteConflict
public Observable> deleteConflict(String conflictLink, RequestOptions options)
删除冲突。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除冲突的单个资源响应。 如果失败，将 Observable 出错。
参数:
conflictLink
- 冲突链接。
options
- 请求选项。
返回:
， Observable 包含针对已删除冲突或错误的单个资源响应。
deleteDatabase
public Observable> deleteDatabase(String databaseLink, RequestOptions options)
删除数据库。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除数据库的单个资源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
options
- 请求选项。
返回:
， Observable 包含单个资源响应，其中包含已删除的数据库或错误。
deleteDocument
public Observable> deleteDocument(String documentLink, RequestOptions options)
通过文档链接删除文档。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除文档的单个资源响应。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
options
- 请求选项。
返回:
， Observable 包含已删除文档的单个资源响应或错误。
deletePermission
public Observable> deletePermission(String permissionLink, RequestOptions options)
删除权限。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除权限的单个资源响应。 如果失败，将 Observable 出错。
参数:
permissionLink
- 权限链接。
options
- 请求选项。
返回:
， Observable 包含已删除权限或错误的单个资源响应。
deleteStoredProcedure
public Observable> deleteStoredProcedure(String storedProcedureLink, RequestOptions options)
通过存储过程链接删除存储过程。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除存储过程的单个资源响应。 如果失败，将 Observable 出错。
参数:
storedProcedureLink
- 存储过程链接。
options
- 请求选项。
返回:
， Observable 包含已删除存储过程或错误的单个资源响应。
deleteTrigger
public Observable> deleteTrigger(String triggerLink, RequestOptions options)
删除触发器。
订阅后，将执行该操作。 成功完成时， Observable 将包含已删除触发器的单个资源响应。 如果失败，将 Observable 出错。
参数:
triggerLink
- 触发器链接。
options
- 请求选项。
返回:
， Observable 包含已删除触发器的单个资源响应或错误。
deleteUser
public Observable> deleteUser(String userLink, RequestOptions options)
删除用户。
订阅后，将执行该操作。 成功完成后， Observable 将包含已删除用户的单个资源响应。 如果失败，将 Observable 出错。
参数:
userLink
- 用户链接。
options
- 请求选项。
返回:
， Observable 包含已删除用户的单个资源响应或错误。
deleteUserDefinedFunction
public Observable> deleteUserDefinedFunction(String udfLink, RequestOptions options)
删除用户定义的函数。
订阅后，将执行该操作。 成功完成时， Observable 将包含已删除的用户定义函数的单个资源响应。 如果失败，将 Observable 出错。
参数:
udfLink
- 用户定义的函数链接。
options
- 请求选项。
返回:
， Observable 包含已删除用户定义函数的单个资源响应或错误。
executeStoredProcedure
public Observable executeStoredProcedure(String storedProcedureLink, Object[] procedureParams)
通过存储过程链接执行存储过程。
订阅后，将执行该操作。 成功完成后， Observable 将包含包含存储过程响应的单个资源响应。 如果失败，将 Observable 出错。
参数:
storedProcedureLink
- 存储过程链接。
procedureParams
- 过程参数值的数组。
返回:
， Observable 包含具有存储过程响应或错误的单个资源响应。
executeStoredProcedure
public Observable executeStoredProcedure(String storedProcedureLink, RequestOptions options, Object[] procedureParams)
通过存储过程链接执行存储过程。
订阅后，将执行该操作。 成功完成后， Observable 将包含包含存储过程响应的单个资源响应。 如果失败，将 Observable 出错。
参数:
storedProcedureLink
- 存储过程链接。
options
- 请求选项。
procedureParams
- 过程参数值的数组。
返回:
， Observable 包含具有存储过程响应或错误的单个资源响应。
getConnectionPolicy
public ConnectionPolicy getConnectionPolicy()
获取连接策略
返回:
连接策略
getDatabaseAccount
public Observable getDatabaseAccount()
获取数据库帐户信息。
订阅后，将执行该操作。 成功完成后， Observable 将包含数据库帐户的单个资源响应。 如果失败，将 Observable 出错。
返回:
， Observable 包含包含数据库帐户或错误的单个资源响应。
getReadEndpoint
public URI getReadEndpoint()
获取基于可用性和首选项选择的当前读取终结点。
返回:
读取终结点 URI
getServiceEndpoint
public URI getServiceEndpoint()
获取用户在构造过程中传入的默认服务终结点。
返回:
服务终结点 URI
getWriteEndpoint
public URI getWriteEndpoint()
获取根据可用性和首选项选择的当前写入终结点。
返回:
写入终结点 URI
monitor
public static void monitor(MeterRegistry registry)
添加用于报告直接 TCP 指标的计量注册表
参数:
registry
- 用于报告直接 TCP 指标的计量注册表
queryAttachments
public Observable> queryAttachments(String documentLink, SqlQuerySpec querySpec, FeedOptions options)
查询附件。
订阅后，将执行该操作。 将 Observable 包含获取的附件的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
， Observable 包含获取的附件的一个或多个源响应页或错误。
queryAttachments
public Observable> queryAttachments(String documentLink, String query, FeedOptions options)
查询附件。
订阅后，将执行该操作。 将 Observable 包含获取的附件的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
query
- 查询。
options
- 源选项。
返回:
， Observable 包含获取的附件的一个或多个源响应页或错误。
queryCollections
public Observable> queryCollections(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)
查询数据库中的文档集合。
订阅后，将执行该操作。 将 Observable 包含所获取集合的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
， Observable 包含获取集合的一个或多个源响应页或错误。
queryCollections
public Observable> queryCollections(String databaseLink, String query, FeedOptions options)
查询数据库中的文档集合。
订阅后，将执行该操作。 将 Observable 包含所获取集合的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
query
- 查询。
options
- 源选项。
返回:
， Observable 包含获取集合的一个或多个源响应页或错误。
queryConflicts
public Observable> queryConflicts(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)
查询冲突。
订阅后，将执行该操作。 将 Observable 包含获取的冲突的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
， Observable 包含获取的冲突或错误的一个或多个源响应页。
queryConflicts
public Observable> queryConflicts(String collectionLink, String query, FeedOptions options)
查询冲突。
订阅后，将执行该操作。 将 Observable 包含获取的冲突的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
query
- 查询。
options
- 源选项。
返回:
， Observable 包含获取的冲突或错误的一个或多个源响应页。
queryDatabases
public Observable> queryDatabases(SqlQuerySpec querySpec, FeedOptions options)
查询数据库。
订阅后，将执行该操作。
Observable将包含所获取数据库的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
包含 Observable 所获取数据库的一个或多个源响应页或错误。
queryDatabases
public Observable> queryDatabases(String query, FeedOptions options)
查询数据库。
订阅后，将执行该操作。 将 Observable 包含读取数据库的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
query
- 查询。
options
- 源选项。
返回:
， Observable 包含一个或多个读取数据库的源响应页或错误。
queryDocumentChangeFeed
public Observable> queryDocumentChangeFeed(String collectionLink, ChangeFeedOptions changeFeedOptions)
查询文档集合中的文档更改源。 订阅后，将执行该操作。 将 Observable 包含所获取文档的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
collectionLink
- 指向父文档集合的链接。
changeFeedOptions
- 更改源选项。
返回:
包含 Observable 所获取文档的一个或多个源响应页或错误。
queryDocuments
public Observable> queryDocuments(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)
查询文档集合中的文档。
订阅后，将执行该操作。 将 Observable 包含所获取文档的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 指向父文档集合的链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
包含 Observable 所获取文档的一个或多个源响应页或错误。
queryDocuments
public Observable> queryDocuments(String collectionLink, String query, FeedOptions options)
查询文档集合中的文档。
订阅后，将执行该操作。 将 Observable 包含所获取文档的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 指向父文档集合的链接。
query
- 查询。
options
- 源选项。
返回:
包含 Observable 所获取文档的一个或多个源响应页或错误。
queryOffers
public Observable> queryOffers(SqlQuerySpec querySpec, FeedOptions options)
查询数据库中的产品/服务。
订阅后，将执行该操作。 将 Observable 包含获取的套餐的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
querySpec
- 查询规范。
options
- 源选项。
返回:
， Observable 包含获取的产品/服务或错误的一个或多个源响应页。
queryOffers
public Observable> queryOffers(String query, FeedOptions options)
查询数据库中的产品/服务。
订阅后将执行该操作。
Observable将包含获取的套餐的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
query
- 查询。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的产品/服务或错误的一个或多个源响应页。
queryPermissions
public Observable> queryPermissions(String permissionLink, SqlQuerySpec querySpec, FeedOptions options)
查询权限。
订阅后将执行该操作。
Observable将包含已获取权限的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
permissionLink
- 权限链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的权限或错误的一个或多个源响应页。
queryPermissions
public Observable> queryPermissions(String permissionLink, String query, FeedOptions options)
查询权限。
订阅后将执行该操作。
Observable将包含已获取权限的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
permissionLink
- 权限链接。
query
- 查询。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的权限或错误的一个或多个源响应页。
queryStoredProcedures
public Observable> queryStoredProcedures(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)
查询文档集合中的存储过程。
订阅后将执行该操作。
Observable将包含获取的存储过程的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的存储过程或错误的一个或多个源响应页。
queryStoredProcedures
public Observable> queryStoredProcedures(String collectionLink, String query, FeedOptions options)
查询文档集合中的存储过程。
订阅后将执行该操作。
Observable将包含获取的存储过程的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
query
- 查询。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的存储过程或错误的一个或多个源响应页。
queryTriggers
public Observable> queryTriggers(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)
查询触发器。
订阅后将执行该操作。
Observable将包含获取的触发器的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的触发器或错误的一个或多个源响应页。
queryTriggers
public Observable> queryTriggers(String collectionLink, String query, FeedOptions options)
查询触发器。
订阅后将执行该操作。
Observable将包含获取的触发器的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
query
- 查询。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的触发器或错误的一个或多个源响应页。
queryUserDefinedFunctions
public Observable> queryUserDefinedFunctions(String collectionLink, SqlQuerySpec querySpec, FeedOptions options)
查询用户定义的函数。
订阅后将执行该操作。
Observable将包含获取的用户定义函数的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的用户定义函数的一个或多个源响应页或错误。
queryUserDefinedFunctions
public Observable> queryUserDefinedFunctions(String collectionLink, String query, FeedOptions options)
查询用户定义的函数。
订阅后将执行该操作。
Observable将包含获取的用户定义函数的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
query
- 查询。
options
- 源选项。
返回:
一个 ， Observable 其中包含获取的用户定义函数的一个或多个源响应页或错误。
queryUsers
public Observable> queryUsers(String databaseLink, SqlQuerySpec querySpec, FeedOptions options)
查询用户。
订阅后将执行该操作。
Observable将包含已获取用户的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
databaseLink
- 数据库链接。
querySpec
- SQL 查询规范。
options
- 源选项。
返回:
包含 Observable 已获取用户的一个或多个源响应页或错误的 。
queryUsers
public Observable> queryUsers(String databaseLink, String query, FeedOptions options)
查询用户。
订阅后将执行该操作。
Observable将包含已获取用户的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
databaseLink
- 数据库链接。
query
- 查询。
options
- 源选项。
返回:
包含 Observable 已获取用户的一个或多个源响应页或错误的 。
readAttachment
public Observable> readAttachment(String attachmentLink, RequestOptions options)
读取附件。
订阅后将执行该操作。
Observable成功完成时的 将包含单个资源响应，其中包含读取附件。 如果失败， Observable 将出错。
参数:
attachmentLink
- 附件链接。
options
- 请求选项。
返回:
一个 ， Observable 其中包含具有读取附件或错误的单个资源响应。
readAttachments
public Observable> readAttachments(String documentLink, FeedOptions options)
读取文档中的所有附件。
订阅后将执行该操作。
Observable将包含读取附件的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
documentLink
- 文档链接。
options
- 源选项。
返回:
一个包含 Observable 读取附件或错误的一个或多个源响应页的 。
readCollection
public Observable> readCollection(String collectionLink, RequestOptions options)
通过集合链接读取文档集合。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有读取集合的单个资源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
options
- 请求选项。
返回:
， Observable 包含具有读取集合或错误的单个资源响应。
readCollections
public Observable> readCollections(String databaseLink, FeedOptions options)
读取数据库中的所有文档集合。
订阅后，将执行该操作。 将 Observable 包含读取集合的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
options
- 费用选项。
返回:
， Observable 包含读取集合的一个或多个源响应页或错误。
readConflict
public Observable> readConflict(String conflictLink, RequestOptions options)
读取冲突。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有读取冲突的单个资源响应。 如果失败，将 Observable 出错。
参数:
conflictLink
- 冲突链接。
options
- 请求选项。
返回:
， Observable 包含具有读取冲突或错误的单个资源响应。
readConflicts
public Observable> readConflicts(String collectionLink, FeedOptions options)
读取文档集合中的所有冲突。
订阅后，将执行该操作。 将 Observable 包含读取冲突的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
options
- 源选项。
返回:
， Observable 包含读取冲突或错误的一个或多个源响应页。
readDatabase
public Observable> readDatabase(String databaseLink, RequestOptions options)
读取数据库。
订阅后，将执行该操作。 成功完成后， Observable 将包含读取数据库的单个资源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
options
- 请求选项。
返回:
， Observable 包含具有读取数据库或错误的单个资源响应。
readDatabases
public Observable> readDatabases(FeedOptions options)
读取所有数据库。
订阅后，将执行该操作。 将 Observable 包含读取数据库的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
options
- 源选项。
返回:
， Observable 包含一个或多个读取数据库的源响应页或错误。
readDocument
public Observable> readDocument(String documentLink, RequestOptions options)
通过文档链接读取文档。
订阅后，将执行该操作。 成功完成后， Observable 将包含包含读取文档的单个资源响应。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
options
- 请求选项。
返回:
， Observable 包含具有读取文档或错误的单个资源响应。
readDocuments
public Observable> readDocuments(String collectionLink, FeedOptions options)
读取文档集合中的所有文档。
订阅后，将执行该操作。 将 Observable 包含读取文档的一个或多个源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
options
- 源选项。
返回:
包含 Observable 读取文档的一个或多个源响应页或错误。
readMedia
public Observable readMedia(String mediaLink)
通过媒体链接读取媒体。
参数:
mediaLink
- 媒体链接。
返回:
媒体响应。
readOffer
public Observable> readOffer(String offerLink)
读取产品/服务。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有读取套餐的单个资源响应。 如果失败，将 Observable 出错。
参数:
offerLink
- 产品/服务链接。
返回:
， Observable 包含具有读取套餐或错误的单个资源响应。
readOffers
public Observable> readOffers(FeedOptions options)
读取产品/服务。
订阅后，将执行该操作。 将 Observable 包含读取产品/服务的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
options
- 源选项。
返回:
， Observable 包含读取产品/服务的一个或多个源响应页或错误。
readPartitionKeyRanges
public Observable> readPartitionKeyRanges(String collectionLink, FeedOptions options)
读取文档集合中的所有分区键范围。 订阅后，将执行该操作。 将 Observable 包含获取的分区键范围的一个或多个源响应页。 如果失败，将 Observable 出错。
参数:
collectionLink
- 指向父文档集合的链接。
options
- 源选项。
返回:
， Observable 包含获取的分区键范围的一个或多个源响应页或错误。
readPermission
public Observable> readPermission(String permissionLink, RequestOptions options)
读取权限。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有读取权限的单个资源响应。 如果失败，将 Observable 出错。
参数:
permissionLink
- 权限链接。
options
- 请求选项。
返回:
， Observable 包含具有读取权限或错误的单个资源响应。
readPermissions
public Observable> readPermissions(String permissionLink, FeedOptions options)
读取所有权限。
订阅后，将执行该操作。 将 Observable 包含一个或多个读取权限的源响应页。 如果失败，将 Observable 出错。
参数:
permissionLink
- 权限链接。
options
- 源选项。
返回:
， Observable 包含一个或多个读取权限或错误的源响应页。
readStoredProcedure
public Observable> readStoredProcedure(String storedProcedureLink, RequestOptions options)
通过存储过程链接读取存储过程。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有读取存储过程的单个资源响应。 如果失败，将 Observable 出错。
参数:
storedProcedureLink
- 存储过程链接。
options
- 请求选项。
返回:
， Observable 包含具有读取存储过程或错误的单个资源响应。
readStoredProcedures
public Observable> readStoredProcedures(String collectionLink, FeedOptions options)
读取文档集合链接中的所有存储过程。
订阅后将执行该操作。
Observable将包含读取存储过程的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
options
- 源选项。
返回:
包含 Observable 读取存储过程的一个或多个源响应页或错误的 。
readTrigger
public Observable> readTrigger(String triggerLink, RequestOptions options)
通过触发器链接读取触发器。
订阅后将执行该操作。
Observable成功完成时的 将包含读取触发器的单个资源响应。 如果失败， Observable 将出错。
参数:
triggerLink
- 触发器链接。
options
- 请求选项。
返回:
， Observable 包含读取触发器的单个资源响应或错误。
readTriggers
public Observable> readTriggers(String collectionLink, FeedOptions options)
读取文档集合中的所有触发器。
订阅后将执行该操作。
Observable将包含读取触发器的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
options
- 源选项。
返回:
包含 Observable 读取触发器或错误的一个或多个源响应页的 。
readUser
public Observable> readUser(String userLink, RequestOptions options)
读取用户。
订阅后将执行该操作。
Observable成功完成时的 将包含读取用户的单个资源响应。 如果失败， Observable 将出错。
参数:
userLink
- 用户链接。
options
- 请求选项。
返回:
， Observable 包含具有读取用户或错误的单个资源响应。
readUserDefinedFunction
public Observable> readUserDefinedFunction(String udfLink, RequestOptions options)
读取用户定义的函数。
订阅后将执行该操作。 成功完成时， Observable 将包含读取用户定义函数的单个资源响应。 如果失败， Observable 将出错。
参数:
udfLink
- 用户定义的函数链接。
options
- 请求选项。
返回:
， Observable 包含读取用户定义函数或错误的单个资源响应。
readUserDefinedFunctions
public Observable> readUserDefinedFunctions(String collectionLink, FeedOptions options)
读取文档集合中的所有用户定义的函数。
订阅后将执行该操作。
Observable将包含读取用户定义函数的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
collectionLink
- 集合链接。
options
- 源选项。
返回:
包含 Observable 读取用户定义函数或错误的一个或多个源响应页的 。
readUsers
public Observable> readUsers(String databaseLink, FeedOptions options)
读取数据库中的所有用户。
订阅后将执行该操作。
Observable将包含读取用户的一个或多个源响应页。 如果失败， Observable 将出错。
参数:
databaseLink
- 数据库链接。
options
- 源选项。
返回:
， Observable 包含读取用户的一个或多个源响应页或错误。
replaceAttachment
public Observable> replaceAttachment(Attachment attachment, RequestOptions options)
替换附件。
订阅后将执行该操作。
Observable成功完成时的 将包含单个资源响应，其中包含替换的附件。 如果失败， Observable 将出错。
参数:
attachment
- 要使用的附件。
options
- 请求选项。
返回:
包含 Observable 单个资源响应的 ，其中包含替换的附件或错误。
replaceCollection
public Observable> replaceCollection(DocumentCollection collection, RequestOptions options)
替换文档集合。
订阅后将执行该操作。 成功完成后， Observable 将包含包含替换文档集合的单个资源响应。 如果失败， Observable 将出错。
参数:
collection
- 要使用的文档集合。
options
- 请求选项。
返回:
， Observable 包含单个资源响应以及替换的文档集合或错误。
replaceDocument
public Observable> replaceDocument(Document document, RequestOptions options)
将文档替换为传入的文档。
订阅后将执行该操作。 成功完成后， Observable 将包含包含替换文档的单个资源响应。 如果失败， Observable 将出错。
参数:
document
- 要替换的文档 (包含文档 ID) 。
options
- 请求选项。
返回:
， Observable 包含单个资源响应以及替换的文档或错误。
replaceDocument
public Observable> replaceDocument(String documentLink, Object document, RequestOptions options)
使用 POJO 对象替换文档。
订阅后将执行该操作。 成功完成后， Observable 将包含包含替换文档的单个资源响应。 如果失败， Observable 将出错。
参数:
documentLink
- 文档链接。
document
- 表示为 POJO 或 Document 对象的文档。
options
- 请求选项。
返回:
， Observable 包含单个资源响应以及替换的文档或错误。
replaceOffer
public Observable> replaceOffer(Offer offer)
替换产品/服务。
订阅后将执行该操作。 成功完成后， Observable 将包含包含替换的产品/服务的单一资源响应。 如果失败， Observable 将出错。
参数:
offer
- 要使用的产品/服务。
返回:
， Observable 包含单个资源响应以及替换的产品/服务或错误。
replacePermission
public Observable> replacePermission(Permission permission, RequestOptions options)
替换权限。
订阅后将执行该操作。 成功完成后， Observable 将包含具有已替换权限的单个资源响应。 如果失败， Observable 将出错。
参数:
permission
- 要使用的权限。
options
- 请求选项。
返回:
一个 ， Observable 其中包含单个资源响应，其中包含已替换的权限或错误。
replaceStoredProcedure
public Observable> replaceStoredProcedure(StoredProcedure storedProcedure, RequestOptions options)
替换存储过程。
订阅后将执行该操作。
Observable成功完成时的 将包含单个资源响应和替换的存储过程。 如果失败， Observable 将出错。
参数:
storedProcedure
- 要使用的存储过程。
options
- 请求选项。
返回:
一个 ， Observable 其中包含单个资源响应以及替换的存储过程或错误。
replaceTrigger
public Observable> replaceTrigger(Trigger trigger, RequestOptions options)
替换触发器。
订阅后，将执行该操作。 成功完成时， Observable 将包含单个资源响应和替换的触发器。 如果失败，将 Observable 出错。
参数:
trigger
- 要使用的触发器。
options
- 请求选项。
返回:
一个 ， Observable 包含单个资源响应以及替换的触发器或错误。
replaceUser
public Observable> replaceUser(User user, RequestOptions options)
替换用户。
订阅后，将执行该操作。 成功完成后， Observable 将包含替换用户的单个资源响应。 如果失败，将 Observable 出错。
参数:
user
- 要使用的用户。
options
- 请求选项。
返回:
一个包含 Observable 替换用户或错误的单个资源响应的 。
replaceUserDefinedFunction
public Observable> replaceUserDefinedFunction(UserDefinedFunction udf, RequestOptions options)
替换用户定义的函数。
订阅后，将执行该操作。 成功完成后， Observable 将包含一个具有替换的用户定义函数的资源响应。 如果失败，将 Observable 出错。
参数:
udf
- 用户定义的函数。
options
- 请求选项。
返回:
， Observable 包含单个资源响应，其中包含替换的用户定义函数或错误。
updateMedia
public Observable updateMedia(String mediaLink, InputStream mediaStream, MediaOptions options)
通过媒体链接汇报媒体。
参数:
mediaLink
- 媒体链接。
mediaStream
- 要上传的媒体流。
options
- 媒体选项。
返回:
媒体响应。
upsertAttachment
public Observable> upsertAttachment(String documentLink, Attachment attachment, RequestOptions options)
插入附件。
订阅后，将执行该操作。 成功完成后， Observable 将包含单个资源响应以及已插入的附件。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
attachment
- 要更新插入的附件。
options
- 请求选项。
返回:
， Observable 包含单个资源响应以及已插入的附件或错误。
upsertAttachment
public Observable> upsertAttachment(String documentLink, InputStream mediaStream, MediaOptions options, RequestOptions requestOptions)
将附件插入媒体流
订阅后，将执行该操作。 成功完成后， Observable 将包含单个资源响应以及已插入的附件。 如果失败，将 Observable 出错。
参数:
documentLink
- 文档链接。
mediaStream
- 用于重新插入附件的媒体流。
options
- 媒体选项。
requestOptions
- 请求选项
返回:
， Observable 包含单个资源响应以及已插入的附件或错误。
upsertDocument
public Observable> upsertDocument(String collectionLink, Object document, RequestOptions options, boolean disableAutomaticIdGeneration)
更新插入文档。
订阅后，将执行该操作。 成功完成后， Observable 将包含单个资源响应以及已插入的文档。 如果失败，将 Observable 出错。
参数:
collectionLink
- 指向父文档集合的链接。
document
- 表示为 POJO 或 Document 对象以更新插入的文档。
options
- 请求选项。
disableAutomaticIdGeneration
- 用于禁用自动 ID 生成的标志。
返回:
， Observable 包含单个资源响应，其中包含已更新插入的文档或错误。
upsertPermission
public Observable> upsertPermission(String userLink, Permission permission, RequestOptions options)
更新插入权限。
订阅后，将执行该操作。 成功完成后， Observable 将包含具有向上插入权限的单个资源响应。 如果失败，将 Observable 出错。
参数:
userLink
- 用户链接。
permission
- 向上插入的权限。
options
- 请求选项。
返回:
， Observable 包含具有更新插入权限或错误的单个资源响应。
upsertStoredProcedure
public Observable> upsertStoredProcedure(String collectionLink, StoredProcedure storedProcedure, RequestOptions options)
更新插入存储过程。
订阅后，将执行该操作。 成功完成后， Observable 将包含单个资源响应以及更新插入的存储过程。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
storedProcedure
- 要更新插入的存储过程。
options
- 请求选项。
返回:
一个 ， Observable 包含单个资源响应，其中包含更新插入的存储过程或错误。
upsertTrigger
public Observable> upsertTrigger(String collectionLink, Trigger trigger, RequestOptions options)
更新插入触发器。
订阅后，将执行该操作。 成功完成时， Observable 将包含单个资源响应以及已插入的触发器。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
trigger
- 用于更新插入的触发器。
options
- 请求选项。
返回:
， Observable 包含具有更新插入触发器或错误的单个资源响应。
upsertUser
public Observable> upsertUser(String databaseLink, User user, RequestOptions options)
更新插入用户。
订阅后，将执行该操作。 成功完成后， Observable 将包含一个包含已插入用户的单个资源响应。 如果失败，将 Observable 出错。
参数:
databaseLink
- 数据库链接。
user
- 要更新插入的用户。
options
- 请求选项。
返回:
一个 ， Observable 包含单个资源响应，其中包含已更新插入的用户或错误。
upsertUserDefinedFunction
public Observable> upsertUserDefinedFunction(String collectionLink, UserDefinedFunction udf, RequestOptions options)
更新插入用户定义的函数。
订阅后，将执行该操作。 成功完成时， Observable 将包含具有用户定义函数的单个资源响应。 如果失败，将 Observable 出错。
参数:
collectionLink
- 集合链接。
udf
- 要更新插入的用户定义函数。
options
- 请求选项。
返回:
一个 ， Observable 包含单个资源响应，其中包含已更新插入的用户定义函数或错误。
适用于
