PutObjectsRequest (OBS SDK for Java 3.25.4 API)

java.lang.Object
- com.obs.services.model.GenericRequest
- - com.obs.services.model.AbstractBulkRequest
  - - com.obs.services.model.PutObjectsRequest

public class PutObjectsRequest
extends AbstractBulkRequest

Request parameters for uploading objects in a batch.

字段概要
- 从类继承的字段 com.obs.services.model.AbstractBulkRequest
  taskQueueNum, taskThreadNum
- 从类继承的字段 com.obs.services.model.GenericRequest
  bucketName, cancelHandler, httpMethod, userHeaders

构造器概要

构造器
构造器	说明
`PutObjectsRequest(String bucketName, List<String> filePaths)`	Constructor
`PutObjectsRequest(String bucketName, String folderPath)`	Constructor

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`AccessControlList`	`getAcl()`	Obtain the ACL of the object.
`Set<ExtensionObjectPermissionEnum>`	`getAllGrantPermissions()`	Obtain all OBS extended permissions.
`long`	`getBigfileThreshold()`	Obtain the threshold size of a file for starting multipart upload.
`TaskCallback<PutObjectResult,PutObjectBasicRequest>`	`getCallback()`	Obtain the callback object of an upload task.
`long`	`getDetailProgressInterval()`	Obtain the callback threshold of the data transfer listener.
`Set<String>`	`getDomainIdsByGrantPermission(ExtensionObjectPermissionEnum extensionPermissionEnum)`	Obtain the list of user IDs with the specified OBS extension permissions.
`Map<ExtensionObjectPermissionEnum,Set<String>>`	`getExtensionPermissionMap()`	Obtain the set of relationships between users and OBS extension permissions.
`List<String>`	`getFilePaths()`	Obtain the list of local paths of the batch uploaded files.
`String`	`getFolderPath()`	Obtain the local path of the uploaded folder.
`Set<ExtensionObjectPermissionEnum>`	`getGrantPermissionsByDomainId(String domainId)`	Obtain the OBS extension permissions of a specified user.
`long`	`getPartSize()`	Obtain the part size set for uploading an object.
`String`	`getPrefix()`	Obtain the specific folder to which the file is uploaded.
`SseCHeader`	`getSseCHeader()`	Obtain SSE-C encryption headers of the object.
`SseKmsHeader`	`getSseKmsHeader()`	Obtain SSE-KMS encryption headers of the object.
`String`	`getSuccessRedirectLocation()`	Obtain the redirection address after a successfully responded request.
`int`	`getTaskNum()`	Obtain the maximum number of threads used for processing upload tasks concurrently.
`long`	`getTaskProgressInterval()`	Obtain the interval for updating the task progress information.
`UploadObjectsProgressListener`	`getUploadObjectsProgressListener()`	Obtain the progress listener of the bulk task.
`void`	`grantExtensionPermission(String domainId, ExtensionObjectPermissionEnum extensionPermissionEnum)`	Grant the OBS extension permissions to a user.
`void`	`setAcl(AccessControlList acl)`	Set the object ACL.
`void`	`setBigfileThreshold(long bigfileThreshold)`	Set the threshold size of a file for starting multipart upload.
`void`	`setCallback(TaskCallback<PutObjectResult,PutObjectBasicRequest> callback)`	Set the callback object of an upload task.
`void`	`setDetailProgressInterval(long detailProgressInterval)`	Set the callback threshold of the data transfer listener.
`void`	`setExtensionPermissionMap(Map<ExtensionObjectPermissionEnum,Set<String>> extensionPermissionMap)`	Set the set of relationships between users and OBS extension permissions.
`void`	`setPartSize(long partSize)`	Set the part size for uploading the object.
`void`	`setPrefix(String prefix)`	Set the specific folder to which the file is uploaded.
`void`	`setSseCHeader(SseCHeader sseCHeader)`	Set SSE-C encryption headers of the object.
`void`	`setSseKmsHeader(SseKmsHeader sseKmsHeader)`	Set SSE-KMS encryption headers of the object.
`void`	`setSuccessRedirectLocation(String successRedirectLocation)`	Set the redirection address after a successfully responded request.
`void`	`setTaskNum(int taskNum)`	Set the maximum number of threads used for processing upload tasks concurrently.
`void`	`setTaskProgressInterval(long taskProgressInterval)`	Set the interval for updating the task progress information.
`void`	`setUploadObjectsProgressListener(UploadObjectsProgressListener listener)`	Set the progress listener of the bulk task.
`String`	`toString()`
`void`	`withdrawExtensionPermission(String domainId, ExtensionObjectPermissionEnum extensionPermissionEnum)`	Withdraw the OBS extension permissions from a user.
`void`	`withdrawExtensionPermissions(String domainId)`	Withdraw all OBS extension permissions from a user.

从类继承的方法 com.obs.services.model.AbstractBulkRequest
getProgressInterval, getProgressListener, getTaskQueueNum, getTaskThreadNum, setProgressInterval, setProgressListener, setTaskQueueNum, setTaskThreadNum

从类继承的方法 com.obs.services.model.GenericRequest
addUserHeaders, getBucketName, getCancelHandler, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setCancelHandler, setRequesterPays, setUserHeaders

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - PutObjectsRequest
```
public PutObjectsRequest(String bucketName,
                         String folderPath)
```
    Constructor
    
    参数:
    
    bucketName - Bucket name
    
    folderPath - Local path from which the folder is uploaded
  - PutObjectsRequest
```
public PutObjectsRequest(String bucketName,
                         List<String> filePaths)
```
    Constructor
    
    参数:
    
    bucketName - Bucket name
    
    filePaths - List of local paths from which a batch of files are uploaded
- 方法详细资料
  - getFolderPath
```
public String getFolderPath()
```
    Obtain the local path of the uploaded folder.
    
    返回:
    
    folderPath Local path from which the folder is uploaded
  - getFilePaths
```
public List<String> getFilePaths()
```
    Obtain the list of local paths of the batch uploaded files.
    
    返回:
    
    filePaths List of local paths from which a batch of files are uploaded
  - getCallback
```
public TaskCallback<PutObjectResult,PutObjectBasicRequest> getCallback()
```
    Obtain the callback object of an upload task.
    
    返回:
    
    callback Callback object
  - setCallback
```
public void setCallback(TaskCallback<PutObjectResult,PutObjectBasicRequest> callback)
```
    Set the callback object of an upload task.
    
    参数:
    
    callback - Callback object
  - getPartSize
```
public long getPartSize()
```
    Obtain the part size set for uploading an object.
    
    返回:
    
    partSize Part size
  - setPartSize
```
public void setPartSize(long partSize)
```
    Set the part size for uploading the object.
    
    参数:
    
    partSize - Part size
  - getBigfileThreshold
```
public long getBigfileThreshold()
```
    Obtain the threshold size of a file for starting multipart upload.
    
    返回:
    
    bigfileThreshold Threshold size of a file for multipart upload
  - setBigfileThreshold
```
public void setBigfileThreshold(long bigfileThreshold)
```
    Set the threshold size of a file for starting multipart upload.
    
    参数:
    
    bigfileThreshold - Threshold size of a file for multipart upload
  - getTaskNum
```
public int getTaskNum()
```
    Obtain the maximum number of threads used for processing upload tasks concurrently.
    
    返回:
    
    Maximum number of threads used for processing upload tasks concurrently
  - setTaskNum
```
public void setTaskNum(int taskNum)
```
    Set the maximum number of threads used for processing upload tasks concurrently.
    
    参数:
    
    taskNum - Maximum number of threads used for processing upload tasks concurrently
  - getPrefix
```
public String getPrefix()
```
    Obtain the specific folder to which the file is uploaded.
    
    返回:
    
    prefix Folder
  - setPrefix
```
public void setPrefix(String prefix)
```
    Set the specific folder to which the file is uploaded.
    
    参数:
    
    prefix - Folder
  - getUploadObjectsProgressListener
```
public UploadObjectsProgressListener getUploadObjectsProgressListener()
```
    Obtain the progress listener of the bulk task.
    
    返回:
    
    Progress listener
  - setUploadObjectsProgressListener
```
public void setUploadObjectsProgressListener(UploadObjectsProgressListener listener)
```
    Set the progress listener of the bulk task.
    
    参数:
    
    listener - Progress listener
  - getTaskProgressInterval
```
public long getTaskProgressInterval()
```
    Obtain the interval for updating the task progress information.
    
    返回:
    
    taskProgressInterval Interval for updating the task progress
  - setTaskProgressInterval
```
public void setTaskProgressInterval(long taskProgressInterval)
```
    Set the interval for updating the task progress information.
    
    参数:
    
    taskProgressInterval - Interval for updating the task progress
  - getDetailProgressInterval
```
public long getDetailProgressInterval()
```
    Obtain the callback threshold of the data transfer listener. The default value is 100 KB.
    
    返回:
    
    Callback threshold of the data transfer listener
  - setDetailProgressInterval
```
public void setDetailProgressInterval(long detailProgressInterval)
```
    Set the callback threshold of the data transfer listener. The default value is 100 KB.
    
    参数:
    
    detailProgressInterval - Callback threshold of the data transfer listener
  - getSseKmsHeader
```
public SseKmsHeader getSseKmsHeader()
```
    Obtain SSE-KMS encryption headers of the object.
    
    返回:
    
    SSE-KMS encryption headers
  - setSseKmsHeader
```
public void setSseKmsHeader(SseKmsHeader sseKmsHeader)
```
    Set SSE-KMS encryption headers of the object.
    
    参数:
    
    sseKmsHeader - SSE-KMS encryption headers
  - getSseCHeader
```
public SseCHeader getSseCHeader()
```
    Obtain SSE-C encryption headers of the object.
    
    返回:
    
    SSE-C encryption headers
  - setSseCHeader
```
public void setSseCHeader(SseCHeader sseCHeader)
```
    Set SSE-C encryption headers of the object.
    
    参数:
    
    sseCHeader - SSE-C encryption headers
  - getAcl
```
public AccessControlList getAcl()
```
    Obtain the ACL of the object.
    
    返回:
    
    Object ACL
  - setAcl
```
public void setAcl(AccessControlList acl)
```
    Set the object ACL.
    
    参数:
    
    acl - Object ACL
  - getSuccessRedirectLocation
```
public String getSuccessRedirectLocation()
```
    Obtain the redirection address after a successfully responded request.
    
    返回:
    
    Redirection address
  - setSuccessRedirectLocation
```
public void setSuccessRedirectLocation(String successRedirectLocation)
```
    Set the redirection address after a successfully responded request.
    
    参数:
    
    successRedirectLocation - Redirection address
  - grantExtensionPermission
```
public void grantExtensionPermission(String domainId,
                                     ExtensionObjectPermissionEnum extensionPermissionEnum)
```
    Grant the OBS extension permissions to a user.
    
    参数:
    
    domainId - User's domain ID
    
    extensionPermissionEnum - OBS extension permissions
  - withdrawExtensionPermission
```
public void withdrawExtensionPermission(String domainId,
                                        ExtensionObjectPermissionEnum extensionPermissionEnum)
```
    Withdraw the OBS extension permissions from a user.
    
    参数:
    
    domainId - User's domain ID
    
    extensionPermissionEnum - OBS extension permissions
  - withdrawExtensionPermissions
```
public void withdrawExtensionPermissions(String domainId)
```
    Withdraw all OBS extension permissions from a user.
    
    参数:
    
    domainId - User's domain ID
  - getAllGrantPermissions
```
public Set<ExtensionObjectPermissionEnum> getAllGrantPermissions()
```
    Obtain all OBS extended permissions.
    
    返回:
    
    OBS List of extension permissions
  - getDomainIdsByGrantPermission
```
public Set<String> getDomainIdsByGrantPermission(ExtensionObjectPermissionEnum extensionPermissionEnum)
```
    Obtain the list of user IDs with the specified OBS extension permissions.
    
    参数:
    
    extensionPermissionEnum - OBS extension permissions
    
    返回:
    
    List of user IDs
  - getGrantPermissionsByDomainId
```
public Set<ExtensionObjectPermissionEnum> getGrantPermissionsByDomainId(String domainId)
```
    Obtain the OBS extension permissions of a specified user.
    
    参数:
    
    domainId - User ID
    
    返回:
    
    OBS Extension permission set
  - getExtensionPermissionMap
```
public Map<ExtensionObjectPermissionEnum,Set<String>> getExtensionPermissionMap()
```
    Obtain the set of relationships between users and OBS extension permissions.
    
    返回:
    
    Set of relationships between users and OBS extended permissions
  - setExtensionPermissionMap
```
public void setExtensionPermissionMap(Map<ExtensionObjectPermissionEnum,Set<String>> extensionPermissionMap)
```
    Set the set of relationships between users and OBS extension permissions.
    
    参数:
    
    extensionPermissionMap - Set of relationships between users and OBS extended permissions
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 GenericRequest

类 PutObjectsRequest

字段概要

从类继承的字段 com.obs.services.model.AbstractBulkRequest

从类继承的字段 com.obs.services.model.GenericRequest

构造器概要

方法概要

从类继承的方法 com.obs.services.model.AbstractBulkRequest

从类继承的方法 com.obs.services.model.GenericRequest

从类继承的方法 java.lang.Object

构造器详细资料

PutObjectsRequest

PutObjectsRequest

方法详细资料

getFolderPath

getFilePaths

getCallback

setCallback

getPartSize

setPartSize

getBigfileThreshold

setBigfileThreshold

getTaskNum

setTaskNum

getPrefix

setPrefix

getUploadObjectsProgressListener

setUploadObjectsProgressListener

getTaskProgressInterval

setTaskProgressInterval

getDetailProgressInterval

setDetailProgressInterval

getSseKmsHeader

setSseKmsHeader

getSseCHeader

setSseCHeader

getAcl

setAcl

getSuccessRedirectLocation

setSuccessRedirectLocation

grantExtensionPermission

withdrawExtensionPermission

withdrawExtensionPermissions

getAllGrantPermissions

getDomainIdsByGrantPermission

getGrantPermissionsByDomainId

getExtensionPermissionMap

setExtensionPermissionMap

toString