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

CloudFileClient 类

包:

com.microsoft.azure.storage.file

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.file.CloudFileClient

public class CloudFileClient extends ServiceClient

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

此类提供对文件服务的访问点。 服务客户端封装文件服务的基本 URI。 它还封装用于访问存储帐户的凭据。

构造函数摘要

构造函数	说明
CloudFileClient(final URI baseUri, StorageCredentials credentials)	使用指定的文件服务终结点和帐户凭据创建 类的实例。
CloudFileClient(StorageUri storageUri, StorageCredentials credentials)	使用指定的文件服务终结点和帐户凭据创建 类的实例。

方法摘要

修饰符和类型	方法和描述
final FileServiceProperties	downloadServiceProperties() 检索给定存储服务的当前 FileServiceProperties 。 这会封装 CORS 配置。
final FileServiceProperties	downloadServiceProperties(FileRequestOptions options, OperationContext opContext) 检索给定存储服务的当前 FileServiceProperties 。 这会封装 CORS 配置。
FileRequestOptions	getDefaultRequestOptions() 获取 FileRequestOptions 用于与此关联的请求的
CloudFileShare	getShareReference(final String shareName) 获取具有 CloudFileShare 指定名称的 对象。
CloudFileShare	getShareReference(final String shareName, String snapshotID) 获取具有 CloudFileShare 指定名称的 对象。
boolean	isUsePathStyleUris() 指示是否正在使用路径样式 URI。
Iterable<CloudFileShare>	listShares() 返回此文件服务客户端的可枚举共享集合。
Iterable<CloudFileShare>	listShares(final String prefix) 返回共享的可枚举集合，其名称以此文件服务客户端的指定前缀开头。
Iterable<CloudFileShare>	listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final FileRequestOptions options, final OperationContext opContext) 使用指定的详细信息设置、请求选项和操作上下文，返回名称以此文件服务客户端的指定前缀开头的共享的可枚举集合。
ResultSegment<CloudFileShare>	listSharesSegmented() 返回此文件服务客户端的可枚举共享集合的结果段。
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix) 返回共享的可枚举集合的结果段，其名称以此文件服务客户端的指定前缀开头。
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext) 使用指定的列表详细信息选项、请求选项和操作上下文返回名称以指定前缀开头的共享的可枚举集合的结果段。
void	setDefaultRequestOptions(FileRequestOptions defaultRequestOptions) FileRequestOptions设置用于与此 对象关联的任何请求的 。
void	uploadServiceProperties(final FileServiceProperties properties) 将新 FileServiceProperties 配置上传到给定的存储服务。 这会封装 CORS 配置。
void	uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext) 将新 FileServiceProperties 配置上传到给定的存储服务。 这会封装 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)

构造函数详细信息

CloudFileClient

public CloudFileClient(final URI baseUri, StorageCredentials credentials)

使用指定的文件服务终结点和帐户凭据创建 类的实例。

Parameters:

baseUri - 一个 java.net.URI 对象，表示用于创建客户端的文件服务终结点。

credentials - 一个 StorageCredentials 表示帐户凭据的 对象。

CloudFileClient

public CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

使用指定的文件服务终结点和帐户凭据创建 类的实例。

Parameters:

storageUri - 一个 StorageUri 对象，表示用于创建客户端的文件服务终结点。

credentials - 一个 StorageCredentials 表示帐户凭据的 对象。

方法详细信息

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties()

检索给定存储服务的当前 FileServiceProperties 。 这会封装 CORS 配置。

Returns:

一个 FileServiceProperties 表示服务的当前配置的 对象。

Throws:

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

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

检索给定存储服务的当前 FileServiceProperties 。 这会封装 CORS 配置。

Parameters:

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

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

Returns:

一个 FileServiceProperties 表示服务的当前配置的 对象。

Throws:

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

getDefaultRequestOptions

public FileRequestOptions getDefaultRequestOptions()

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

Returns:

包含 FileRequestOptions 由此使用的值的 对象 CloudFileClient

getShareReference

public CloudFileShare getShareReference(final String shareName)

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

Parameters:

shareName - 共享的名称，它必须遵守共享命名规则。 共享名称不应包含 /) (任何路径分隔符。 共享名称必须为小写，长度介于 3-63 个字符之间，并且必须以字母或数字开头。 共享名称只能包含字母、数字和短划线 ( ) 字符。

Returns:

对 CloudFileShare 对象的引用。

Throws:

StorageException

URISyntaxException

getShareReference

public CloudFileShare getShareReference(final String shareName, String snapshotID)

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

Parameters:

shareName - 共享的名称，它必须遵守共享命名规则。 共享名称不应包含 /) (任何路径分隔符。 共享名称必须为小写，长度介于 3-63 个字符之间，并且必须以字母或数字开头。 共享名称只能包含字母、数字和短划线 ( ) 字符。

snapshotID - 一个 String ，表示共享的快照 ID。

Returns:

对 CloudFileShare 对象的引用。

Throws:

StorageException

URISyntaxException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

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

Returns:

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

listShares

public Iterable listShares()

返回此文件服务客户端的可枚举共享集合。

Returns:

延迟检索的 CloudFileShare 对象的可枚举集合，表示此客户端的共享。

listShares

public Iterable listShares(final String prefix)

返回共享的可枚举集合，其名称以此文件服务客户端的指定前缀开头。

Parameters:

prefix - 表示 String 共享名称前缀的 。

Returns:

延迟检索的 CloudFileShare 对象的可枚举集合，这些对象表示名称以指定前缀开头的此客户端的共享。

listShares

public Iterable listShares(final String prefix, final EnumSet detailsIncluded, final FileRequestOptions options, final OperationContext opContext)

使用指定的详细信息设置、请求选项和操作上下文，返回名称以此文件服务客户端的指定前缀开头的共享的可枚举集合。

Parameters:

prefix - 表示 String 共享名称前缀的 。

detailsIncluded - 一个 java.util.EnumSet 对象，该对象包含 ShareListingDetails 指示是否将返回共享快照和/或元数据的值。

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

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

Returns:

延迟检索的 CloudFileShare 对象的可枚举集合，表示此客户端的共享。

listSharesSegmented

public ResultSegment listSharesSegmented()

返回此文件服务客户端的可枚举共享集合的结果段。

Returns:

一个 ResultSegment<T> 对象，该对象包含表示此客户端共享的 CloudFileShare 对象的可枚举集合的段。

Throws:

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

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix)

返回共享的可枚举集合的结果段，其名称以此文件服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，表示共享名称的前缀。

Returns:

一个 ResultSegment<T> 对象，该对象包含对象的可枚举集合的 CloudFileShare 段，这些对象表示其名称以指定前缀开头的共享。

Throws:

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

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix, final EnumSet detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext)

使用指定的列表详细信息选项、请求选项和操作上下文返回名称以指定前缀开头的共享的可枚举集合的结果段。

Parameters:

prefix - 一个 String ，表示共享名称的前缀。

detailsIncluded - 一个 java.util.EnumSet 对象，该对象包含 ShareListingDetails 指示是否将返回共享快照和/或元数据的值。

maxResults - 要检索的最大结果数。 如果 null 或大于 5000，服务器将返回最多 5,000 个项目。 必须至少为 1。

continuationToken - 一个 ResultContinuation 对象，表示上一个列表操作返回的继续标记。

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

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

Returns:

一个 ResultSegment<T> 对象，该对象包含表示此客户端共享的 CloudFileShare 对象的可枚举集合的段。

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

FileRequestOptions设置用于与此 对象关联的任何请求的 。

Parameters:

defaultRequestOptions - 一个 FileRequestOptions 指定要使用的选项的 对象。

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties)

将新 FileServiceProperties 配置上传到给定的存储服务。 这会封装 CORS 配置。

Parameters:

properties - 一个 FileServiceProperties 对象，该对象指定要上传的服务属性。

Throws:

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

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

将新 FileServiceProperties 配置上传到给定的存储服务。 这会封装 CORS 配置。

Parameters:

properties - 一个 FileServiceProperties 对象，该对象指定要上传的服务属性。

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

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

Throws:

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