@Generated(value="software.amazon.awssdk:codegen") public class PutObjectRequest extends S3Request implements ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutObjectRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ObjectCannedACL |
acl()
The canned ACL to apply to the object.
|
String |
aclString()
The canned ACL to apply to the object.
|
String |
bucket()
Name of the bucket to which the PUT operation was initiated.
|
static PutObjectRequest.Builder |
builder() |
String |
cacheControl()
Specifies caching behavior along the request/reply chain.
|
String |
contentDisposition()
Specifies presentational information for the object.
|
String |
contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header field.
|
String |
contentLanguage()
The language the content is in.
|
Long |
contentLength()
Size of the body in bytes.
|
String |
contentMD5()
The base64-encoded 128-bit MD5 digest of the part data.
|
String |
contentType()
A standard MIME type describing the format of the object data.
|
boolean |
equals(Object obj) |
Instant |
expires()
The date and time at which the object is no longer cacheable.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
String |
grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
String |
grantRead()
Allows grantee to read the object data and its metadata.
|
String |
grantReadACP()
Allows grantee to read the object ACL.
|
String |
grantWriteACP()
Allows grantee to write the ACL for the applicable object.
|
int |
hashCode() |
String |
key()
Object key for which the PUT operation was initiated.
|
Map<String,String> |
metadata()
A map of metadata to store with the object in S3.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerString()
Returns the value of the RequestPayer property for this object.
|
static Class<? extends PutObjectRequest.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
|
String |
serverSideEncryptionString()
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
|
String |
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (e.g., AES256).
|
String |
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
String |
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
String |
ssekmsKeyId()
Specifies the AWS KMS key ID to use for object encryption.
|
StorageClass |
storageClass()
The type of storage to use for the object.
|
String |
storageClassString()
The type of storage to use for the object.
|
String |
tagging()
The tag-set for the object.
|
PutObjectRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
websiteRedirectLocation()
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket
or to an external URL.
|
requestOverrideConfig
copy
public ObjectCannedACL acl()
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclString()
.
ObjectCannedACL
public String aclString()
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclString()
.
ObjectCannedACL
public String bucket()
public String cacheControl()
public String contentDisposition()
public String contentEncoding()
public String contentLanguage()
public Long contentLength()
public String contentMD5()
public String contentType()
public Instant expires()
public String grantFullControl()
public String grantRead()
public String grantReadACP()
public String grantWriteACP()
public String key()
public Map<String,String> metadata()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public ServerSideEncryption serverSideEncryption()
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionString()
.
ServerSideEncryption
public String serverSideEncryptionString()
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionString()
.
ServerSideEncryption
public StorageClass storageClass()
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassString()
.
StorageClass
public String storageClassString()
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassString()
.
StorageClass
public String websiteRedirectLocation()
public String sseCustomerAlgorithm()
public String sseCustomerKey()
public String sseCustomerKeyMD5()
public String ssekmsKeyId()
public RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerString()
.
RequestPayer
public String requestPayerString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerString()
.
RequestPayer
public String tagging()
public PutObjectRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
toBuilder
in class S3Request
public static PutObjectRequest.Builder builder()
public static Class<? extends PutObjectRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.