|
||||||||||
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
public class PutObjectRequest
Uploads a new object to the specified Baidu Bos bucket. The PutObjectRequest 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 | |
---|---|
|
PutObjectRequest(String bucketName,
String key,
File file)
Constructs a new PutObjectRequest object to upload a file to the specified bucket and key. |
protected |
PutObjectRequest(String bucketName,
String key,
File file,
InputStream inputStream,
ObjectMetadata objectMetadata)
Constructs a new PutObjectRequest object to upload a file and a stream of data to the specified bucket and key. |
|
PutObjectRequest(String bucketName,
String key,
File file,
ObjectMetadata metadata)
Constructs a new PutObjectRequest object to upload a file to the specified bucket and key. |
|
PutObjectRequest(String bucketName,
String key,
InputStream inputStream)
Constructs a new PutObjectRequest object to upload a stream of data to the specified bucket and key. |
|
PutObjectRequest(String bucketName,
String key,
InputStream inputStream,
ObjectMetadata metadata)
Constructs a new PutObjectRequest object to upload a stream of data to the specified bucket and key. |
Method Summary | |
---|---|
File |
getFile()
Gets the path and name of the file containing the data to be uploaded to Baidu Bos. |
InputStream |
getInputStream()
Gets the input stream containing the data to be uploaded to Baidu Bos. |
ObjectMetadata |
getObjectMetadata()
Gets the optional metadata instructing Baidu Bos how to handle the uploaded data (e.g. |
String |
getStorageClass()
Gets the storageClass of the input file which is be uploaded to Baidu Bos. |
void |
setFile(File file)
Sets the path and name of the file containing the data to be uploaded to Baidu Bos. |
void |
setInputStream(InputStream inputStream)
Sets the input stream containing the data to be uploaded to Baidu Bos. |
void |
setObjectMetadata(ObjectMetadata objectMetadata)
Sets the optional metadata instructing Baidu Bos how to handle the uploaded data (e.g. |
void |
setStorageClass(String storageClass)
Sets the storageClass of the input file which is be uploaded to Baidu Bos. |
PutObjectRequest |
withBucketName(String bucketName)
Sets the name of the bucket where this request will upload a new object to. |
PutObjectRequest |
withFile(File file)
Sets the file containing the data to be uploaded to Baidu Bos. |
PutObjectRequest |
withInputStream(InputStream inputStream)
Sets the input stream containing the data to be uploaded to Baidu Bos. |
PutObjectRequest |
withKey(String key)
Sets the key under which to store the new object. |
PutObjectRequest |
withObjectMetadata(ObjectMetadata objectMetadata)
Sets the optional metadata instructing Baidu Bos how to handle the uploaded data (e.g. |
PutObjectRequest |
withRequestCredentials(BceCredentials credentials)
|
PutObjectRequest |
withStorageClass(String storageClass)
Sets the storageClass of the input file which is be uploaded to Baidu Bos. |
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 PutObjectRequest(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 PutObjectRequest(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 PutObjectRequest(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 PutObjectRequest(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.protected PutObjectRequest(String bucketName, String key, File file, InputStream inputStream, ObjectMetadata objectMetadata)
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.inputStream
- The stream of data to upload to Baidu Bos.objectMetadata
- The object metadata. At minimum this specifies the
content length for the stream of data being uploaded.Method Detail |
---|
public PutObjectRequest withRequestCredentials(BceCredentials credentials)
withRequestCredentials
in class AbstractBceRequest
public PutObjectRequest withBucketName(String bucketName)
withBucketName
in class GenericBucketRequest
bucketName
- The name of an existing bucket where this request will upload a new object to.
public PutObjectRequest withKey(String key)
withKey
in class GenericObjectRequest
key
- The key under which to store the new object.
public File getFile()
public void setFile(File file)
file
- The path and name of the file containing the data to be uploaded to Baidu Bos.public PutObjectRequest withFile(File file)
Either specify a file or an input stream containing the data to be uploaded to Baidu Bos; both cannot be specified.
file
- The file containing the data to be uploaded to Baidu Bos.
public ObjectMetadata getObjectMetadata()
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.
public void setObjectMetadata(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.
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 PutObjectRequest 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.
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 InputStream getInputStream()
public void setInputStream(InputStream inputStream)
inputStream
- The input stream containing the data to be uploaded to Baidu Bos.
Either specify a file or an input stream containing the data to be uploaded to Baidu Bos, not both.public PutObjectRequest withInputStream(InputStream inputStream)
Either specify a file or an input stream containing the data to be uploaded to Baidu Bos; both cannot be specified.
inputStream
- The InputStream containing the data to be uploaded to Baidu Bos.
public String getStorageClass()
public void setStorageClass(String storageClass)
storageClass
- The StorageClass is an identification that distinguish between infrequent access bos
and standard bos.public PutObjectRequest withStorageClass(String storageClass)
storageClass
- The StorageClass is an identification that distinguish between infrequent access bos
and standard bos.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |