| Class Info |
|---|
| public class StorageReference 云端文件的引用的实现类,提供文件的列举、上传、下载、删除、元数据更新等各项操作的封装。 |
| Qualifier and Type | Method Name and Description |
|---|---|
| PutObjectResult | putObject(String objectName, File srcFile) throws StorageException 将本地文件使用文件上传接口上传到云端。 |
| PutObjectResult | putObject(String objectName, File srcFile, ObjectMetadata metadata) throws StorageException 将本地文件使用文件上传接口上传到云端。 |
| PutObjectResult | putObject(String objectName, InputStream stream, long uploadSize) throws StorageException 将本地数据流使用文件上传接口上传到云端。 |
| PutObjectResult | putObject(String objectName, InputStream stream, ObjectMetadata metadata) throws StorageException 将本地数据流使用文件上传接口上传到云端。 |
| PutObjectResult | putObject(PutObjectRequest request) throws StorageException 将本地文件使用文件上传接口上传到云端。 |
| DownloadFileResult | download(DownloadFileRequest request) throws StorageException 从云端获取文件信息。 |
| CopyObjectResult | copyObject(CopyObjectRequest request) 将云端的文件拷贝一个副本。 |
| CopyObjectResult | copyObject(String destObjectName) 将云端的文件拷贝一个副本。 |
| CopyObjectResult | copyObject(String srcObjectName, String destObjectName) 将云端的文件拷贝一个副本。 |
| CopyObjectResult | copyObject(String destObjectName, ObjectMetadata metadata) 将云端的文件拷贝一个副本。 |
| CopyObjectResult | copyObject(String srcObjectName, String destObjectName, ObjectMetadata metadata) 将云端的文件拷贝一个副本。 |
| DeleteObjectResult | deleteObject() throws StorageException 删除文件。 |
| DeleteObjectResult | deleteObject(String objectName) throws StorageException 删除文件。 |
| DeleteObjectsResult | deleteObjects(List<String> objectNames) throws StorageException 批量删除文件。 |
| DeleteObjectsResult | deleteObjects(DeleteObjectsRequest request) throws StorageException 批量删除文件。 |
| ListObjectsResult | listObjects(ListObjectsRequest request) throws StorageException 枚举当前引用下的文件。 |
| ObjectMetadata | getObjectMetadata() throws StorageException 获取当前引用文件的元数据。 |
| ObjectMetadata | getObjectMetadata(String objectName) throws StorageException 获取文件元数据。 |
| ObjectMetadata | updateObjectMetadata(ObjectMetadata metadata) throws StorageException 更新当前引用文件的元数据。 |
| ObjectMetadata | updateObjectMetadata(String objectName, ObjectMetadata metadata) throws StorageException 更新文件元数据。 |
| ObjectMetadata | updateObjectMetadata(SetObjectMetadataRequest request) throws StorageException 更新文件元数据。 |
| boolean | doesObjectExist() throws StorageException 判断当前引用文件是否存在。 |
| boolean | doesObjectExist(String objectName) throws StorageException 判断文件是否存在。 |
| String | resetToken() throws StorageException 将旧的令牌删除,重置一个新的令牌。 |
| String | resetToken(String objectName) throws StorageException 将旧的令牌删除,重置一个新的令牌。 |
| List<String> | appendToken() throws StorageException 在当前文件的引用下创建一个新的令牌。 |
| List<String> | appendToken(String objectName) throws StorageException 在指定的文件的引用下创建一个新的令牌。 |
| List<String> | deleteToken(String objectName, String token) throws StorageException 删除指定的云端文件的指定令牌,并返回剩余的令牌。 |
| List<String> | deleteToken(String token) throws StorageException 删除引用的指定令牌,并返回剩余的令牌。 |
| DownloadUrlResult | getObjectUrlFromToken(String objectName) throws StorageException 获取采用文件令牌下载的下载地址。 |
| DownloadListUrlResult | getObjectListUrlFromToken(String objectNames) throws StorageException 批量获取采用文件令牌下载的下载地址。 |
| StorageManagement | 获取当前使用的存储实例类。 |
| StorageReference | child(String objectPath) 获取子目录的引用。 |
| StorageReference | 获取父目录的引用。 |
| StorageReference | getRoot() 获取根目录引用。 |
| String | 获取引用所在的存储实例名称。 |
| String | 获取引用所在的存储实例的区域信息。 |
| String | getName() 获取文件名。 |
| String | getPath() 获取云端文件的路径。 |
| int | compareTo(StorageReference other) 比较引用地址。 |
| String | toString() 获取引用的Url地址。 |
| boolean | equals(Object other) 比较引用是否相同。 |
| int | hashCode() 获取引用的hashcode值。 |
| Method |
|---|
| public PutObjectResult putObject(String objectName, File srcFile) throws StorageException 将本地文件使用文件上传接口上传到云端。 |
Parameters
| Name | Description |
|---|---|
| objectName | 本地文件存储到云端的名称(可包含云端路径,当不包含路径时,存在当前目录),名称限制详细请参见使用限制。 |
| srcFile | 本地文件。 |
Return
| Type | Description |
|---|---|
| PutObjectResult | 上传的结果信息。 |
| Method |
|---|
| public PutObjectResult putObject(String objectName, File srcFile, ObjectMetadata metadata) throws StorageException 将本地文件使用文件上传接口上传到云端。 |
Parameters
| Name | Description |
|---|---|
| objectName | 本地文件存储到云端的名称(可包含云端路径,当不包含路径时,存在当前目录),名称限制详细请参见使用限制。 |
| srcFile | 本地文件。 |
| metadata | 元数据信息。 |
Return
| Type | Description |
|---|---|
| PutObjectResult | 上传的结果信息。 |
| Method |
|---|
| public PutObjectResult putObject(String objectName, InputStream stream, long uploadSize) throws StorageException 将本地数据流使用文件上传接口上传到云端。 |
Parameters
| Name | Description |
|---|---|
| objectName | 本地文件存储到云端的名称(可包含云端路径,当不包含路径时,存在当前目录),名称限制详细请参见使用限制。 |
| stream | 待上传数据流。 |
| uploadSize | 上传数据流长度。uploadSize必须与stream的长度保持一致,如果stream的长度为0,则上传失败。 |
Return
| Type | Description |
|---|---|
| PutObjectResult | 上传的结果信息。 |
| Method |
|---|
| public PutObjectResult putObject(String objectName, InputStream stream, ObjectMetadata metadata) throws StorageException 将本地数据流使用文件上传接口上传到云端。 |
Parameters
| Name | Description |
|---|---|
| objectName | 本地文件存储到云端的名称(可包含云端路径,当不包含路径时,存在当前目录),名称限制详细请参见使用限制。 |
| stream | 待上传数据流。 |
| metadata | 上传数据流的元数据信息。 |
Return
| Type | Description |
|---|---|
| PutObjectResult | 上传的结果信息。 |
| Method |
|---|
| public PutObjectResult putObject(PutObjectRequest request) throws StorageException 将本地文件使用文件上传接口上传到云端。 |
Parameters
| Name | Description |
|---|---|
| request | 上传的请求信息。 |
Return
| Type | Description |
|---|---|
| PutObjectResult | 上传的结果信息。 |
| Method |
|---|
| public DownloadFileResult download(DownloadFileRequest request) throws StorageException 使用下载接口将云端文件下载到本地。 |
Parameters
| Name | Description |
|---|---|
| request | 下载的请求信息。 |
Return
| Type | Description |
|---|---|
| DownloadFileResult | 下载的结果信息。 |
| Method |
|---|
| public CopyObjectResult copyObject(CopyObjectRequest request) 将云端的文件拷贝一个副本。 注意: 拷贝的源文件大小超过1GB不建议使用此接口。如果源文件大小超过1GB,该操作容易发生拷贝超时并导致拷贝失败。如确实需要拷贝超过1GB的文件,请采用下载该文件并重新上传的方式替代拷贝操作。 |
Parameters
| Name | Description |
|---|---|
| request | 拷贝请求的请求信息。 |
Return
| Type | Description |
|---|---|
| CopyObjectResult | 拷贝请求的结果信息。 |
| Method |
|---|
| public CopyObjectResult copyObject(String destObjectName) 将云端的文件拷贝一个副本。 注意: 拷贝的源文件大小超过1GB不建议使用此接口。如果源文件大小超过1GB,该操作容易发生拷贝超时并导致拷贝失败。如确实需要拷贝超过1GB的文件,请采用下载该文件并重新上传的方式替代拷贝操作。 |
Parameters
| Name | Description |
|---|---|
| destObjectName | 云端的目标文件名。 |
Return
| Type | Description |
|---|---|
| CopyObjectResult | 拷贝请求的结果信息。 |
| Method |
|---|
| public CopyObjectResult copyObject(String srcObjectName, String destObjectName) 将云端的文件拷贝一个副本。 注意: 拷贝的源文件大小超过1GB不建议使用此接口。如果源文件大小超过1GB,该操作容易发生拷贝超时并导致拷贝失败。如确实需要拷贝超过1GB的文件,请采用下载该文件并重新上传的方式替代拷贝操作。 |
Parameters
| Name | Description |
|---|---|
| srcObjectName | 云端的源文件名。 |
| destObjectName | 云端的目标文件名。 |
Return
| Type | Description |
|---|---|
| CopyObjectResult | 拷贝请求的结果信息。 |
| Method |
|---|
| public CopyObjectResult copyObject(String destObjectName, ObjectMetadata metadata) 将云端的文件拷贝一个副本。 注意: 拷贝的源文件大小超过1GB不建议使用此接口。如果源文件大小超过1GB,该操作容易发生拷贝超时并导致拷贝失败。如确实需要拷贝超过1GB的文件,请采用下载该文件并重新上传的方式替代拷贝操作。 |
Parameters
| Name | Description |
|---|---|
| destObjectName | 云端的目标文件名。 |
| metadata | 目标文件的元数据信息。 |
Return
| Type | Description |
|---|---|
| CopyObjectResult | 拷贝请求的结果信息。 |
| Method |
|---|
| public CopyObjectResult copyObject(String srcObjectName, String destObjectName, ObjectMetadata metadata) 将云端的文件拷贝一个副本。 注意: 拷贝的源文件大小超过1GB不建议使用此接口。如果源文件大小超过1GB,该操作容易发生拷贝超时并导致拷贝失败。如确实需要拷贝超过1GB的文件,请采用下载该文件并重新上传的方式替代拷贝操作。 |
Parameters
| Name | Description |
|---|---|
| srcObjectName | 云端的源文件名。 |
| destObjectName | 云端的目标文件名。 |
| metadata | 目标文件的元数据信息。 |
Return
| Type | Description |
|---|---|
| CopyObjectResult | 拷贝请求的结果信息。 |
| Method |
|---|
| public DeleteObjectResult deleteObject() throws StorageException 删除对象。 说明: 如果删除的对象为目录,仅仅删除目录对象,不会删除目录下的文件。如果要删除目录下的文件,需要枚举出目录下的文件,并进行循环删除。 |
Return
| Type | Description |
|---|---|
| DeleteObjectResult | 删除请求的结果信息。 |
| Method |
|---|
| public DeleteObjectResult deleteObject(String objectName) throws StorageException 删除对象。 说明: 如果删除的对象为目录,仅仅删除目录对象,不会删除目录下的文件。如果要删除目录下的文件,需要枚举出目录下的文件,并进行循环删除。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端的对象名。 |
Return
| Type | Description |
|---|---|
| DeleteObjectResult | 删除请求的结果信息。 |
| Method |
|---|
| public DeleteObjectsResult deleteObjects(List<String> objectNames) throws StorageException 批量删除对象。 |
Parameters
| Name | Description |
|---|---|
| objectNames | 待删除的云端对象名列表。 |
Return
| Type | Description |
|---|---|
| DeleteObjectsResult | 删除请求的结果信息。 |
| Method |
|---|
| public DeleteObjectsResult deleteObjects(DeleteObjectsRequest request) throws StorageException 批量删除对象。 |
Parameters
| Name | Description |
|---|---|
| request | 待删除的云端对象名列表。 |
Return
| Type | Description |
|---|---|
| DeleteObjectsResult | 删除请求的结果信息。 |
| Method |
|---|
| public ListObjectsResult listObjects(ListObjectsRequest request) throws StorageException 枚举当前引用下的文件。 |
Parameters
| Name | Description |
|---|---|
| request | 待枚举的云端源文件列表。 |
Return
| Type | Description |
|---|---|
| ListObjectsResult | 枚举请求的结果信息。 |
| Method |
|---|
| public ObjectMetadata getObjectMetadata() throws StorageException 获取当前引用文件的元数据。 |
Return
| Type | Description |
|---|---|
| ObjectMetadata | 文件的元数据。 |
| Method |
|---|
| public ObjectMetadata getObjectMetadata(String objectName) throws StorageException 获取文件的元数据。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端的文件名。 |
Return
| Type | Description |
|---|---|
| ObjectMetadata | 文件的元数据。 |
| Method |
|---|
| public ObjectMetadata updateObjectMetadata(ObjectMetadata metadata) throws StorageException 更新当前引用文件的元数据。 |
Parameters
| Name | Description |
|---|---|
| metadata | 元数据信息。 |
Return
| Type | Description |
|---|---|
| ObjectMetadata | 最新的文件元数据。 |
| Method |
|---|
| public ObjectMetadata updateObjectMetadata(String objectName, ObjectMetadata metadata) throws StorageException 更新文件的元数据。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端的文件名。 |
| metadata | 元数据信息。 |
Return
| Type | Description |
|---|---|
| ObjectMetadata | 最新的文件元数据。 |
| Method |
|---|
| public ObjectMetadata updateObjectMetadata(SetObjectMetadataRequest request) throws StorageException 更新文件的元数据。 |
Parameters
| Name | Description |
|---|---|
| request | 元数据的请求信息。 |
Return
| Type | Description |
|---|---|
| ObjectMetadata | 最新的文件元数据。 |
| Method |
|---|
| public boolean doesObjectExist() throws StorageException 判断当前引用文件是否存在。 |
Return
| Type | Description |
|---|---|
| boolean | 判断当前引用文件是否存在。
|
| Method |
|---|
| public boolean doesObjectExist(String objectName) throws StorageException 判断指定的云端的文件是否存在。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端文件名。 |
Return
| Type | Description |
|---|---|
| boolean | 判断指定的云端的文件是否存在。
|
| Method |
|---|
| public String resetToken() throws StorageException 将旧的令牌删除,重置一个新的令牌。 |
Return
| Type | Description |
|---|---|
| String | 新的令牌。 |
| Method |
|---|
| public String resetToken(String objectName) throws StorageException 将旧的令牌删除,重置一个新的令牌。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端文件名。 |
Return
| Type | Description |
|---|---|
| String | 新的令牌。 |
| Method |
|---|
| public List<String> appendToken() throws StorageException 在当前文件的引用下创建一个新的令牌。 说明: 如果当前引用下已有令牌,则返回该令牌。 |
Return
| Type | Description |
|---|---|
| List<String> | 新的令牌列表。 |
| Method |
|---|
| public List<String> appendToken(String objectName) throws StorageException 在指定的文件的引用下创建一个新的令牌。 说明: 如果当前引用下已有令牌,则返回该令牌。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端文件名。 |
Return
| Type | Description |
|---|---|
| List<String> | 新的令牌列表。 |
| Method |
|---|
| public List<String> deleteToken(String objectName, String token) throws StorageException 删除指定的云端文件的指定令牌,并返回剩余的令牌。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端文件名。 |
| token | 指定的待删除的令牌。 |
Return
| Type | Description |
|---|---|
| List<String> | 剩余令牌列表。 |
| Method |
|---|
| public List<String> deleteToken(String token) throws StorageException 删除引用的指定令牌,并返回剩余的令牌。 |
Parameters
| Name | Description |
|---|---|
| token | 指定的待删除的令牌。 |
Return
| Type | Description |
|---|---|
| List<String> | 剩余令牌列表。 |
| Method |
|---|
| public DownloadUrlResult getObjectUrlFromToken(String objectName) throws StorageException 获取当前云端文件使用令牌方式进行下载的下载地址。 |
Parameters
| Name | Description |
|---|---|
| objectName | 云端文件名。 |
Return
| Type | Description |
|---|---|
| DownloadUrlResult | 下载地址信息的结果。 |
| Method |
|---|
| DownloadListUrlResult getObjectListUrlFromToken(String objectNames) throws StorageException 批量获取当前云端文件使用令牌方式进行下载的下载地址。 |
Parameters
| Name | Description |
|---|---|
| objectNames | 云端文件名称。多个名称使用 “|” 隔开,最多支持100个文件。 |
Return
| Type | Description |
|---|---|
| DownloadListUrlResult | 云端文件对应下载地址信息结果。 |
| Method |
|---|
| public StorageManagement getStorage() 获取当前使用的存储实例。 |
Return
| Type | Description |
|---|---|
| StorageManagement |
| Method |
|---|
| public StorageReference child(String objectPath) 获取子目录的引用。 |
Parameters
| Name | Description |
|---|---|
| objectPath | 云端文件名。 |
Return
| Type | Description |
|---|---|
| StorageReference | StorageReference的实例。 |
| Method |
|---|
| public StorageReference getParent() 获取父目录的引用。 |
Return
| Type | Description |
|---|---|
| StorageReference | StorageReference的实例。 |
| Method |
|---|
| public StorageReference getRoot() 获取根目录引用。 |
Return
| Type | Description |
|---|---|
| StorageReference | StorageReference的实例。 |
| Method |
|---|
| public String getBucketName() 获取引用所在的存储实例名称。 |
Return
| Type | Description |
|---|---|
| String | 存储实例名称。 |
| Method |
|---|
| public String getStorageArea() 获取引用所在的存储实例的区域信息。 |
Return
| Type | Description |
|---|---|
| String | 存储实例的区域信息。 |
| Method |
|---|
| public int compareTo(StorageReference other) 比较引用地址。 |
Parameters
| Name | Description |
|---|---|
| other | 待比较的文件引用。 |
Return
| Type | Description |
|---|---|
| int | 两个云端文件引用比较的结果。 |
| Method |
|---|
| public String toString() 获取引用的Url地址。 |
Return
| Type | Description |
|---|---|
| String | 云端文件引用的Url地址。 |