你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CloudTableClient 类

包:

com.microsoft.azure.storage.table

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.table.CloudTableClient

public class CloudTableClient extends ServiceClient

提供用于访问 Microsoft Azure 表服务的服务客户端。

类 CloudTableClient 封装表服务终结点的基 URI 和用于访问存储帐户的凭据，并提供用于创建、删除、列出和查询表的方法，以及对表实体执行操作和查询的方法。 这些方法调用存储服务 REST API 操作以发出请求并获取返回的结果。

表服务终结点是表服务资源的基 URI，包括存储帐户的 DNS 名称：

有关详细信息，请参阅 MSDN 主题 寻址表服务资源。

凭据可以是存储帐户名称和密钥的组合，也可以是共享访问签名。 有关详细信息，请参阅 MSDN 主题 验证对存储帐户的访问权限。

构造函数摘要

构造函数	说明
CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)	使用表服务终结点和存储帐户凭据初始化 类的实例。
CloudTableClient(final URI baseUri, StorageCredentials credentials)	使用表服务终结点和存储帐户凭据初始化 类的实例。

方法摘要

修饰符和类型	方法和描述
final ServiceProperties	downloadServiceProperties() 检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
final ServiceProperties	downloadServiceProperties(TableRequestOptions options, OperationContext opContext) 检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
<T extends TableEntity, R> ResultSegment<?>	executeQuerySegmentedImpl(final TableQuery<T> queryToExecute, final EntityResolver<R> resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext) 保留以供内部使用。 使用指定的重试和超时策略执行分段查询操作。
<T extends TableEntity, R> Iterable<?>	generateIteratorForQuery(final TableQuery<T> queryRef, final EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext) 保留以供内部使用。 为分段查询操作生成迭代器。
TableRequestOptions	getDefaultRequestOptions() TableRequestOptions获取用于与此关联的请求的
ServiceStats	getServiceStats() 查询 服务。ServiceStats
ServiceStats	getServiceStats(TableRequestOptions options, OperationContext opContext) 查询给定的存储服务。ServiceStats
CloudTable	getTableReference(final String tableName) 获取具有 CloudTable 指定名称的对象。
final StorageUri	getTransformedEndPoint(final OperationContext opContext)
boolean	isUsePathStyleUris() 指示是否使用路径样式 URI。
Iterable<String>	listTables() 列出存储帐户中的表名称。 此方法使用此实例的 表 服务终结点和存储帐户凭据调用查询表 REST API 来列出表名称。
Iterable<String>	listTables(final String prefix) 列出存储帐户中与指定前缀匹配的表名称。 此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。
Iterable<String>	listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext) 使用指定的 和 OperationContext列出存储帐户中与指定前缀匹配的TableRequestOptions表名称。 此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。 TableRequestOptions使用 替代操作的超时或重试策略等执行选项。
ResultSegment<String>	listTablesSegmented() 列出处于分段模式的存储帐户中的表名称。 此方法允许在返回部分结果集后，使用服务器在 对象中 ResultSegment<T> 返回的信息来恢复表列表。 此方法使用此实例的 表 服务终结点和存储帐户凭据调用查询表 REST API 来列出表名称。
ResultSegment<String>	listTablesSegmented(final String prefix) 列出存储帐户中与分段模式下指定前缀匹配的表名称。 此方法允许在返回部分结果集后，使用服务器在 对象中 ResultSegment<T> 返回的信息来恢复表列表。 此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。
ResultSegment<String>	listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext) 使用TableRequestOptions指定的 和 OperationContext列出存储帐户中最多指定的表名称，这些表名与可恢复模式下的ResultContinuation指定前缀匹配。 此方法允许使用 对象中的 ResultSegment<T> 服务器返回的信息，在返回结果页后恢复表列表。 此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。 TableRequestOptions使用 替代操作的超时或重试策略等执行选项。
void	setDefaultRequestOptions(TableRequestOptions defaultRequestOptions) TableRequestOptions设置用于使用此 对象访问的任何表的 。
void	uploadServiceProperties(final ServiceProperties properties) 将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
void	uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext) 将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

继承成员

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

构造函数详细信息

CloudTableClient

public CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)

使用表服务终结点和存储帐户凭据初始化 类的实例。

Parameters:

baseUri - 一个 StorageUri 对象，表示用于初始化客户端的表服务终结点。

credentials - 一个 StorageCredentials 对象，表示用于访问的存储帐户凭据。

CloudTableClient

public CloudTableClient(final URI baseUri, StorageCredentials credentials)

使用表服务终结点和存储帐户凭据初始化 类的实例。

Parameters:

baseUri - 一个 java.net.URI 对象，表示用于初始化客户端的表服务终结点。

credentials - 一个 StorageCredentials 对象，表示用于访问的存储帐户凭据。

方法详细信息

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Returns:

表示 ServiceProperties 服务的当前配置的 对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(TableRequestOptions options, OperationContext opContext)

检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

表示 ServiceProperties 服务的当前配置的 对象。

Throws:

StorageException - 如果发生存储服务错误。

executeQuerySegmentedImpl

protected ResultSegment executeQuerySegmentedImpl(final TableQuery queryToExecute, final EntityResolver resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)

保留以供内部使用。 使用指定的重试和超时策略执行分段查询操作。

Parameters:

queryToExecute - TableQuery<T>要执行的 。

resolver - 一个 EntityResolver<T> 实例，用于创建从表查询结果实体到指定类型 R 的映射。 传递 null 以将结果作为表实体类型返回。

continuationToken - 要 ResultContinuation 随操作一起传递的 ，以恢复查询（如果有）。 传递 null 初始查询。

options - 一个 TableRequestOptions 对象，该对象指定执行选项，例如操作的重试策略和超时设置。 指定 null 以使用 上 CloudTableClient指定的请求选项。

opContext - 用于跟踪当前操作的 OperationContext 对象。 指定 null 以安全地忽略操作上下文。

Returns:

一 ResultSegment<T> 个 ，包含专用于查询返回的 TableEntity 或 EntityResolver<T> 类型的查询结果集合。

Throws:

StorageException - 如果发生存储服务错误，则为 。

generateIteratorForQuery

protected Iterable generateIteratorForQuery(final TableQuery queryRef, final EntityResolver resolver, TableRequestOptions options, OperationContext opContext)

保留以供内部使用。 为分段查询操作生成迭代器。

Parameters:

queryRef - TableQuery<T>要执行的 。

resolver - 一个 EntityResolver<T> 实例，用于创建从表查询结果实体到指定类型 R 的映射。 传递 null 以将结果作为表实体类型返回。

options - 一个 TableRequestOptions 对象，该对象指定执行选项，例如操作的重试策略和超时设置。 指定 null 以使用 上 CloudTableClient指定的请求选项。

opContext - 用于跟踪当前操作的 OperationContext 对象。 指定 null 以安全地忽略操作上下文。

Returns:

查询TableEntity返回的 Iterable 或 EntityResolver<T> 类型的专用实例。

getDefaultRequestOptions

public TableRequestOptions getDefaultRequestOptions()

TableRequestOptions获取用于与此关联的请求的

Returns:

包含 TableRequestOptions 由此使用的值的对象 CloudTableClient

getServiceStats

public ServiceStats getServiceStats()

查询 服务。ServiceStats

Returns:

ServiceStats 给定存储服务的

Throws:

StorageException - 如果发生存储服务错误。

getServiceStats

public ServiceStats getServiceStats(TableRequestOptions options, OperationContext opContext)

查询给定的存储服务。ServiceStats

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

ServiceStats 给定存储服务的

Throws:

StorageException - 如果发生存储服务错误。

getTableReference

public CloudTable getTableReference(final String tableName)

获取具有 CloudTable 指定名称的对象。

Parameters:

tableName - 一个 String ，它表示表的名称，该表必须遵循表命名规则。 表名称不应包含 /) (的任何路径分隔符。 表名称不区分大小写，在帐户中必须是唯一的，并且长度必须介于 3-63 个字符之间。 表名必须以 开头，不能以数字字符开头，并且只能包含字母数字字符。 某些表名是保留的，包括“table”。

Returns:

对 CloudTable 对象的引用。

Throws:

URISyntaxException - 如果基于 tableName 构造的资源 URI 无效。

StorageException - 如果发生存储服务错误。

getTransformedEndPoint

protected final StorageUri getTransformedEndPoint(final OperationContext opContext)

Parameters:

opContext

isUsePathStyleUris

protected boolean isUsePathStyleUris()

指示是否使用路径样式 URI。

Returns:

true 如果使用路径样式 URI，则为 ;否则为 false。

listTables

public Iterable listTables()

列出存储帐户中的表名称。

此方法使用此实例的 表 服务终结点和存储帐户凭据调用查询表 REST API 来列出表名称。

Returns:

Iterable存储帐户中表名称的集合已延迟检索。

listTables

public Iterable listTables(final String prefix)

列出存储帐户中与指定前缀匹配的表名称。

此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。

Parameters:

prefix - 一个 String ，它包含要与要返回的表名称匹配的前缀。

Returns:

Iterable存储帐户中与指定前缀匹配的表名称的集合被延迟检索。

listTables

public Iterable listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)

使用指定的 和 OperationContext列出存储帐户中与指定前缀匹配的TableRequestOptions表名称。

此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。

TableRequestOptions使用 替代操作的超时或重试策略等执行选项。

Parameters:

prefix - 一个 String ，它包含要与要返回的表名称匹配的前缀。

options - 一个 TableRequestOptions 对象，该对象指定执行选项，例如操作的重试策略和超时设置。 指定 null 以使用 上 CloudTableClient指定的请求选项。

opContext - 用于跟踪当前操作的 OperationContext 对象。 指定 null 以安全地忽略操作上下文。

Returns:

Iterable存储帐户中与指定前缀匹配的表名称的集合被延迟检索。

listTablesSegmented

public ResultSegment listTablesSegmented()

列出处于分段模式的存储帐户中的表名称。 此方法允许在返回部分结果集后，使用服务器在 对象中 ResultSegment<T> 返回的信息来恢复表列表。

此方法使用此实例的 表 服务终结点和存储帐户凭据调用查询表 REST API 来列出表名称。

Returns:

String包含ResultSegment<T>存储帐户中表名称的 对象的 。

Throws:

StorageException - 如果在操作期间发生存储服务错误，则为 。

listTablesSegmented

public ResultSegment listTablesSegmented(final String prefix)

列出存储帐户中与分段模式下指定前缀匹配的表名称。 此方法允许在返回部分结果集后，使用服务器在 对象中 ResultSegment<T> 返回的信息来恢复表列表。

此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。

Parameters:

prefix - 一个 String ，它包含要与要返回的表名称匹配的前缀。

Returns:

String包含ResultSegment<T>与存储帐户中前缀匹配的表名称的 对象的 。

Throws:

StorageException - 如果在操作期间发生存储服务错误，则为 。

listTablesSegmented

public ResultSegment listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)

使用TableRequestOptions指定的 和 OperationContext列出存储帐户中最多指定的表名称，这些表名与可恢复模式下的ResultContinuation指定前缀匹配。 此方法允许使用 对象中的 ResultSegment<T> 服务器返回的信息，在返回结果页后恢复表列表。

此方法调用 查询表 REST API，以使用此实例的表服务终结点和存储帐户凭据列出与前缀匹配的表名称。

TableRequestOptions使用 替代操作的超时或重试策略等执行选项。

Parameters:

prefix - 一个 String ，它包含要与要返回的表名称匹配的前缀。

maxResults - 在 中 ResultSegment<T>返回的最大表名数。 如果此参数为 null，则查询将列出最多 1,000 个结果。

continuationToken - 一个 ResultContinuation 对象，表示当操作返回部分结果时服务器中的继续标记。 在初始调用中指定 null 。 getContinuationToken()对结果调用 方法以获取ResultContinuation在下一次调用中使用的 对象，以恢复查询。

options - 一个 TableRequestOptions 对象，该对象指定执行选项，例如操作的重试策略和超时设置。 指定 null 以使用 上 CloudTableClient指定的请求选项。

opContext - 用于跟踪当前操作的 OperationContext 对象。 指定 null 以安全地忽略操作上下文。

Returns:

String包含ResultSegment<T>存储帐户中表名称的 对象的 。

Throws:

StorageException - 如果在操作期间发生存储服务错误，则为 。

setDefaultRequestOptions

public void setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)

TableRequestOptions设置用于使用此 对象访问的任何表的 。

Parameters:

defaultRequestOptions - 要使用的 TableRequestOptions。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

properties - 要 ServiceProperties 上传的 。

Throws:

StorageException - 如果发生存储服务错误。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext)

将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

properties - 要 ServiceProperties 上传的 。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。