com.obs.services.model

## 类 UploadFileRequest

- java.lang.Object
- - com.obs.services.model.GenericRequest
  - - com.obs.services.model.PutObjectBasicRequest
    - - com.obs.services.model.UploadFileRequest

-     public class UploadFileRequest
      extends PutObjectBasicRequest

  Parameters in a file upload request

- - ### 字段概要

    - ### 从类继承的字段 com.obs.services.model.PutObjectBasicRequest

      `acl, bucketName, extensionPermissionMap, objectKey, sseCHeader, sseKmsHeader, successRedirectLocation`

  - ### 构造器概要

    构造器
    构造器和说明
    `UploadFileRequest(String bucketName, String objectKey)` Constructor
    `UploadFileRequest(String bucketName, String objectKey, String uploadFile)` Constructor
    `UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize)` Constructor
    `UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum)` Constructor
    `UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint)` Constructor
    `UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile)` Constructor
    `UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile, boolean enableCheckSum)` Constructor

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `String` | `getCheckpointFile()` Obtain the file used to record resumable upload progresses.
    `ObjectMetadata` | `getObjectMetadata()` Obtain object properties.
    `long` | `getPartSize()` Obtain the part size set for uploading the object.
    `long` | `getProgressInterval()` Obtain the callback threshold of the data transfer listener.
    `ProgressListener` | `getProgressListener()` Obtain the data transfer listener.
    `int` | `getTaskNum()` Obtain the maximum number of threads used for processing upload tasks concurrently.
    `String` | `getUploadFile()` Obtain the to-be-uploaded local file.
    `boolean` | `isEnableCheckpoint()` Identify whether the resumable mode is enabled.
    `boolean` | `isEnableCheckSum()` Identify whether the file to be uploaded in resumable mode will be verified.
    `void` | `setCheckpointFile(String checkpointFile)` Specify a file used to record resumable upload progresses.
    `void` | `setEnableCheckpoint(boolean enableCheckpoint)` Specify whether to enable the resumable mode.
    `void` | `setEnableCheckSum(boolean enableCheckSum)` Specify whether to verify the file to be uploaded in resumable mode.
    `void` | `setObjectMetadata(ObjectMetadata objectMetadata)` Set object properties.
    `void` | `setPartSize(long partSize)` Set the part size for uploading the object.
    `void` | `setProgressInterval(long progressInterval)` Set the callback threshold of the data transfer listener.
    `void` | `setProgressListener(ProgressListener progressListener)` Set the data transfer listener.
    `void` | `setTaskNum(int taskNum)` Set the maximum number of threads used for executing upload tasks concurrently.
    `void` | `setUploadFile(String uploadFile)` Specify the local file to be uploaded.
    `String` | `toString()`

    - ### 从类继承的方法 com.obs.services.model.PutObjectBasicRequest

      `getAcl, getAllGrantPermissions, getBucketName, getDomainIdsByGrantPermission, getExtensionPermissionMap, getGrantPermissionsByDomainId, getObjectKey, getSseCHeader, getSseKmsHeader, getSuccessRedirectLocation, grantExtensionPermission, setAcl, setBucketName, setExtensionPermissionMap, setObjectKey, setSseCHeader, setSseKmsHeader, setSuccessRedirectLocation, withdrawExtensionPermission, withdrawExtensionPermissions`

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

      `isRequesterPays, setRequesterPays`

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### 构造器详细资料

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey,
                                   String uploadFile)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name
        `uploadFile` - To-be-uploaded local file

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey,
                                   String uploadFile,
                                   long partSize)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name
        `uploadFile` - To-be-uploaded local file
        `partSize` - Part size

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey,
                                   String uploadFile,
                                   long partSize,
                                   int taskNum)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name
        `uploadFile` - To-be-uploaded local file
        `partSize` - Part size
        `taskNum` - Maximum number of threads used for processing upload tasks concurrently

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey,
                                   String uploadFile,
                                   long partSize,
                                   int taskNum,
                                   boolean enableCheckpoint)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name
        `uploadFile` - To-be-uploaded local file
        `partSize` - Part size
        `taskNum` - Maximum number of threads used for processing upload tasks concurrently
        `enableCheckpoint` - Whether to enable the resumable mode

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey,
                                   String uploadFile,
                                   long partSize,
                                   int taskNum,
                                   boolean enableCheckpoint,
                                   String checkpointFile)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name
        `uploadFile` - To-be-uploaded local file
        `partSize` - Part size
        `taskNum` - Maximum number of threads used for processing upload tasks concurrently
        `enableCheckpoint` - Whether to enable the resumable mode
        `checkpointFile` - File used to record resumable upload progresses

    - #### UploadFileRequest

          public UploadFileRequest(String bucketName,
                                   String objectKey,
                                   String uploadFile,
                                   long partSize,
                                   int taskNum,
                                   boolean enableCheckpoint,
                                   String checkpointFile,
                                   boolean enableCheckSum)

      Constructor
      参数:
        `bucketName` - Bucket name
        `objectKey` - Object name
        `uploadFile` - To-be-uploaded local file
        `partSize` - Part size
        `taskNum` - Maximum number of threads used for processing upload tasks concurrently
        `enableCheckpoint` - Whether to enable the resumable mode
        `checkpointFile` - File used to record resumable upload progresses
        `enableCheckSum` - Whether to verify the to-be-uploaded file upon non-initial uploads in resumable upload mode

  - ### 方法详细资料

    - #### getPartSize

          public long getPartSize()

      Obtain the part size set for uploading the object.
      返回:
        Part size

    - #### setPartSize

          public void setPartSize(long partSize)

      Set the part size for uploading the object.
      参数:
        `partSize` - Part size

    - #### 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 executing upload tasks concurrently.
      参数:
        `taskNum` - Maximum number of threads used for processing upload tasks concurrently

    - #### getUploadFile

          public String getUploadFile()

      Obtain the to-be-uploaded local file.
      返回:
        To-be-uploaded local file

    - #### setUploadFile

          public void setUploadFile(String uploadFile)

      Specify the local file to be uploaded.
      参数:
        `uploadFile` - To-be-uploaded local file

    - #### isEnableCheckpoint

          public boolean isEnableCheckpoint()

      Identify whether the resumable mode is enabled.
      返回:
        Identifier specifying whether the resumable mode is enabled

    - #### setEnableCheckpoint

          public void setEnableCheckpoint(boolean enableCheckpoint)

      Specify whether to enable the resumable mode.
      参数:
        `enableCheckpoint` - Identifier specifying whether the resumable mode is enabled

    - #### getCheckpointFile

          public String getCheckpointFile()

      Obtain the file used to record resumable upload progresses.
      返回:
        File used to record upload progresses

    - #### setCheckpointFile

          public void setCheckpointFile(String checkpointFile)

      Specify a file used to record resumable upload progresses.
      参数:
        `checkpointFile` - File used to record upload progresses

    - #### getObjectMetadata

          public ObjectMetadata getObjectMetadata()

      Obtain object properties.
      返回:
        Object properties

    - #### setObjectMetadata

          public void setObjectMetadata(ObjectMetadata objectMetadata)

      Set object properties.
      参数:
        `objectMetadata` - Object properties

    - #### isEnableCheckSum

          public boolean isEnableCheckSum()

      Identify whether the file to be uploaded in resumable mode will be verified.
      返回:
        Identifier specifying whether to verify the to-be-uploaded file

    - #### setEnableCheckSum

          public void setEnableCheckSum(boolean enableCheckSum)

      Specify whether to verify the file to be uploaded in resumable mode.
      参数:
        `enableCheckSum` - Identifier specifying whether to verify the to-be-uploaded file

    - #### getProgressListener

          public ProgressListener getProgressListener()

      Obtain the data transfer listener.
      返回:
        Data transfer listener

    - #### setProgressListener

          public void setProgressListener(ProgressListener progressListener)

      Set the data transfer listener.
      参数:
        `progressListener` - Data transfer listener

    - #### getProgressInterval

          public long getProgressInterval()

      Obtain the callback threshold of the data transfer listener. The default value is 100 KB.
      返回:
        Callback threshold of the data transfer listener

    - #### setProgressInterval

          public void setProgressInterval(long progressInterval)

      Set the callback threshold of the data transfer listener. The default value is 100 KB.
      参数:
        `progressInterval` - Callback threshold of the data transfer listener

    - #### toString

          public String toString()

      覆盖:
        `toString` 在类中 `GenericRequest`

Copyright © 2021. All rights reserved.