你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CloudFileShare 类
- java.
lang. Object - com.
microsoft. azure. storage. file. CloudFileShare
- com.
public class CloudFileShare
表示 Microsoft Azure 文件服务中的共享。
共享保存作为对象封装 CloudFileDirectory 的目录,目录保存文件。 目录还可以包含子目录。
构造函数摘要
构造函数 | 说明 |
---|---|
CloudFileShare(final StorageUri storageUri) |
使用指定的 URI 创建 类的实例。 |
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials) |
使用指定的 StorageUri 和凭据创建 类的实例。 |
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client) |
使用指定的名称和客户端创建 类的实例。 |
CloudFileShare(final URI uri) |
使用指定的 URI 创建 类的实例。 |
CloudFileShare(final URI uri, final StorageCredentials credentials) |
使用指定的 URI 和凭据创建 类的实例。 |
方法摘要
构造函数详细信息
CloudFileShare
public CloudFileShare(final StorageUri storageUri)
使用指定的 URI 创建 类的实例。
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)
使用指定的 StorageUri 和凭据创建 类的实例。
Parameters:
Throws:
CloudFileShare
public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)
使用指定的名称和客户端创建 类的实例。
Parameters:
String
,它表示共享的名称,该共享必须遵循共享命名规则。 共享名称不应包含 /) (的任何路径分隔符。 共享名称必须为小写,长度介于 3-63 个字符之间,并且必须以字母或数字开头。 共享名称只能包含字母、数字和短划线 ( ) 字符。
String
,表示快照版本(如果适用)。
Throws:
CloudFileShare
public CloudFileShare(final URI uri)
使用指定的 URI 创建 类的实例。
Parameters:
java.net.URI
对象,表示共享的绝对 URI。
Throws:
CloudFileShare
public CloudFileShare(final URI uri, final StorageCredentials credentials)
使用指定的 URI 和凭据创建 类的实例。
Parameters:
java.net.URI
对象,表示共享的绝对 URI。
Throws:
方法详细信息
assertNoSnapshot
protected void assertNoSnapshot()
断言共享不是快照。
create
public void create()
创建共享。
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
使用指定的选项和操作上下文创建共享。
Parameters:
Throws:
createFilePermission
public String createFilePermission(String permission)
创建文件权限。
Parameters:
String
对象,表示要创建的文件权限。
Returns:
String
与创建的文件权限关联的文件权限密钥。Throws:
createFilePermission
public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)
创建文件权限。
Parameters:
String
对象,表示要创建的文件权限。
Returns:
String
与创建的文件权限关联的文件权限密钥。Throws:
createIfNotExists
public boolean createIfNotExists()
如果共享不存在,则创建该共享。
Returns:
如果共享不存在但已创建,则为 true
;否则为 false
。
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文创建共享(如果不存在)。
Parameters:
Returns:
如果共享不存在但已创建,则为 true
;否则为 false
。
Throws:
createSnapshot
public final CloudFileShare createSnapshot()
创建共享快照。
Returns:
CloudFileShare
表示共享快照的 对象。Throws:
createSnapshot
public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文创建文件共享的快照。
Parameters:
Returns:
CloudFileShare
表示文件共享快照的 对象。Throws:
createSnapshot
public final CloudFileShare createSnapshot(final HashMap
使用指定的请求选项和操作上下文创建文件共享的快照。
Parameters:
Returns:
CloudFileShare
表示文件共享快照的 对象。Throws:
delete
public void delete()
删除共享。
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文删除共享。
Parameters:
Throws:
delete
public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的快照和请求选项以及操作上下文删除共享。
除非同时删除快照,否则无法删除包含快照的共享。 如果共享具有快照,请在删除基本共享时使用 INCLUDE_SNAPSHOTS 参数中的 值来包括快照。
Parameters:
Throws:
deleteIfExists
public boolean deleteIfExists()
删除共享(如果存在)。
Returns:
true
如果共享存在且已删除,则为 ;否则为 false
。
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文删除共享(如果存在)。
Parameters:
Returns:
true
如果共享存在且已删除,则为 ;否则为 false
。
Throws:
deleteIfExists
public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的快照和请求选项以及操作上下文删除共享(如果存在)。
除非同时删除快照,否则无法删除包含快照的共享。 如果共享具有快照,请在删除基本共享时使用 INCLUDE_SNAPSHOTS 参数中的 值来包括快照。
Parameters:
Returns:
true
如果共享存在且已删除,则为 ;否则为 false
。
Throws:
downloadAttributes
public void downloadAttributes()
下载共享的属性,其中包括元数据和属性。
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文下载共享的属性,其中包括元数据和属性。
Parameters:
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions()
下载共享的权限设置。
Returns:
Throws:
downloadPermissions
public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文下载共享的权限设置。
Parameters:
Returns:
Throws:
exists
public boolean exists()
返回一个值,该值指示共享是否存在。
Returns:
true
如果共享存在,则为 ;否则为 false
。
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文返回一个值,该值指示共享是否存在。
Parameters:
Returns:
true
如果共享存在,则为 ;否则为 false
。
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)
返回共享的共享访问签名。 请注意,这不包含前导“?”。
Parameters:
String
共享级别访问策略的 。
Returns:
String
它表示共享的共享访问签名。Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
返回共享的共享访问签名。 请注意,这不包含前导“?”。
Parameters:
String
共享级别访问策略的 。
Returns:
String
它表示共享的共享访问签名。Throws:
getFilePermission
public String getFilePermission(String filePermissionKey)
获取与文件权限密钥关联的文件权限。
Parameters:
String
表示文件权限密钥的 对象。
Returns:
String
与文件权限密钥关联的文件权限的 。Throws:
getFilePermission
public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)
获取与文件权限密钥关联的文件权限。
Parameters:
String
表示文件权限密钥的 对象。
Returns:
String
与文件权限密钥关联的文件权限的 。Throws:
getMetadata
public HashMap
返回共享的元数据。 此值通过调用 downloadAttributes()来初始化共享中的元数据,并在共享上通过调用 来 uploadMetadata()设置此值。
Returns:
java.util.HashMap
对象,表示共享的元数据。getName
public String getName()
返回共享的名称。
Returns:
String
,它表示共享的名称。getProperties
getQualifiedUri
public final URI getQualifiedUri()
返回此共享的快照或共享访问签名限定 URI。
Returns:
java.net.URI
快照或共享访问签名的 对象。Throws:
getRootDirectoryReference
public CloudFileDirectory getRootDirectoryReference()
返回对 CloudFileDirectory 对象的引用,该对象表示此共享中的根文件目录。
Returns:
Throws:
getServiceClient
public CloudFileClient getServiceClient()
返回与此共享关联的文件服务客户端。
Returns:
getSnapshot
public final String getSnapshot()
返回此共享的 snapshotID。
Returns:
getStats
public ShareStats getStats()
查询此共享的服务 ShareStats。
Returns:
Throws:
getStats
public ShareStats getStats(FileRequestOptions options, OperationContext opContext)
查询此共享的服务 ShareStats。
Parameters:
Returns:
Throws:
getStorageUri
getUri
public URI getUri()
返回此共享的 URI。
Returns:
isSnapshot
public final boolean isSnapshot()
指示此共享是否为快照。
Returns:
true
如果共享是快照,则为 ;否则为 false
。
setMetadata
public void setMetadata(final HashMap
设置要通过 uploadMetadata() 调用在共享上设置的名称/值对的元数据集合。 此集合将覆盖任何现有的共享元数据。 如果此值设置为空集合,则调用时 uploadMetadata() 将清除共享元数据。
Parameters:
java.util.HashMap
对象,表示要分配给共享的元数据。
setProperties
public void setProperties(final FileShareProperties properties)
设置共享的属性。
Parameters:
uploadMetadata
public void uploadMetadata()
上传共享的元数据。
Throws:
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文上传共享的元数据。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions)
上传共享的权限。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文上传共享的权限。
Parameters:
Throws:
uploadProperties
public final void uploadProperties()
汇报存储服务上的共享属性。
使用 downloadAttributes() 从 Microsoft Azure 存储服务检索共享属性和元数据的最新值。
Throws:
uploadProperties
public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用请求选项和操作上下文汇报共享的属性。
使用 downloadAttributes() 从 Microsoft Azure 存储服务检索共享属性和元数据的最新值。
Parameters:
Throws: