|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.baidubce.model.AbstractBceRequest
com.baidubce.services.bos.model.GenericBucketRequest
com.baidubce.services.bos.model.GenericObjectRequest
com.baidubce.services.bos.model.PutObjectRequest
com.baidubce.services.bos.model.AppendObjectRequest
public class AppendObjectRequest
Uploads a new object to the specified Baidu Bos bucket. The AppendObjectRequest optionally uploads object metadata and applies a canned access control policy to the new object.
Baidu Bos never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.
Constructor Summary | |
---|---|
AppendObjectRequest(String bucketName,
String key,
File file)
Constructs a new AppendObjectRequest object to upload a file to the specified bucket and key. |
|
AppendObjectRequest(String bucketName,
String key,
File file,
ObjectMetadata metadata)
Constructs a new AppendObjectRequest object to upload an appendable file to the specified bucket and key. |
|
AppendObjectRequest(String bucketName,
String key,
InputStream inputStream)
Constructs a new AppendObjectRequest object to upload a stream of data to the specified bucket and key. |
|
AppendObjectRequest(String bucketName,
String key,
InputStream inputStream,
ObjectMetadata metadata)
Constructs a new AppendObjectRequest object to upload a stream of data to the specified bucket and key. |
Method Summary | |
---|---|
Long |
getOffset()
Gets the offset of the file, which shows the resume position of appendable file. |
void |
setOffset(Long offset)
Sets the offset of the file, which shows the resume position of appendable file. |
AppendObjectRequest |
withBucketName(String bucketName)
Sets the name of the bucket where this request will upload a new object to. |
AppendObjectRequest |
withFile(File file)
Sets the file containing the data to be uploaded to Baidu Bos. |
AppendObjectRequest |
withInputStream(InputStream inputStream)
Sets the input stream containing the data to be uploaded to Baidu Bos. |
AppendObjectRequest |
withKey(String key)
Sets the key under which to store the new object. |
AppendObjectRequest |
withObjectMetadata(ObjectMetadata objectMetadata)
Sets the optional metadata instructing Baidu Bos how to handle the uploaded data (e.g. |
AppendObjectRequest |
withOffset(Long offset)
Sets the offset of the file, which shows the resume position of appendable file. |
AppendObjectRequest |
withRequestCredentials(BceCredentials credentials)
Sets the optional credentials to use for this request, overriding the default credentials set at the client level. |
Methods inherited from class com.baidubce.services.bos.model.PutObjectRequest |
---|
getFile, getInputStream, getObjectMetadata, getStorageClass, setFile, setInputStream, setObjectMetadata, setStorageClass, withStorageClass |
Methods inherited from class com.baidubce.services.bos.model.GenericObjectRequest |
---|
getKey, setKey |
Methods inherited from class com.baidubce.services.bos.model.GenericBucketRequest |
---|
getBucketName, setBucketName |
Methods inherited from class com.baidubce.model.AbstractBceRequest |
---|
getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AppendObjectRequest(String bucketName, String key, File file)
bucketName
- The name of an existing bucket to which the new object will be uploaded.key
- The key under which to store the new object.file
- The path of the file to upload to Baidu Bos.public AppendObjectRequest(String bucketName, String key, File file, ObjectMetadata metadata)
bucketName
- The name of an existing bucket to which the new object will be uploaded.key
- The key under which to store the new object.file
- The path of the file to upload to Baidu Bos.metadata
- The object metadata. At minimum this specifies the
content length for the stream of data being uploaded.public AppendObjectRequest(String bucketName, String key, InputStream inputStream)
bucketName
- The name of an existing bucket to which the new object will be uploaded.key
- The key under which to store the new object.inputStream
- The stream of data to upload to Baidu Bos.public AppendObjectRequest(String bucketName, String key, InputStream inputStream, ObjectMetadata metadata)
bucketName
- The name of an existing bucket to which the new object will be uploaded.key
- The key under which to store the new object.inputStream
- The stream of data to upload to Baidu Bos.metadata
- The object metadata. At minimum this specifies the
content length for the stream of data being uploaded.Method Detail |
---|
public Long getOffset()
public void setOffset(Long offset)
offset
- The offset indicates the size of data has been uploaded to Baidu bos.public AppendObjectRequest withOffset(Long offset)
offset
- The offset indicates the size of data has been uploaded to Baidu bos.
public AppendObjectRequest withObjectMetadata(ObjectMetadata objectMetadata)
If uploading from an input stream, always specify metadata with the content size set. Otherwise the contents of the input stream have to be buffered in memory before being sent to Baidu Bos. This can cause very negative performance impacts.
withObjectMetadata
in class PutObjectRequest
objectMetadata
- The optional metadata instructing Baidu Bos how to handle the
uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).
public AppendObjectRequest withFile(File file)
Either specify a file or an input stream containing the data to be uploaded to Baidu Bos; both cannot be specified.
withFile
in class PutObjectRequest
file
- The file containing the data to be uploaded to Baidu Bos.
public AppendObjectRequest withInputStream(InputStream inputStream)
Either specify a file or an input stream containing the data to be uploaded to Baidu Bos; both cannot be specified.
withInputStream
in class PutObjectRequest
inputStream
- The InputStream containing the data to be uploaded to Baidu Bos.
public AppendObjectRequest withRequestCredentials(BceCredentials credentials)
withRequestCredentials
in class PutObjectRequest
credentials
- The optional BOS security credentials to use for this request.
public AppendObjectRequest withBucketName(String bucketName)
withBucketName
in class PutObjectRequest
bucketName
- The name of an existing bucket where this request will upload a new object to.
public AppendObjectRequest withKey(String key)
withKey
in class PutObjectRequest
key
- The key under which to store the new object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |