@Generated(value="software.amazon.awssdk:codegen") public final class CreateMultipartUploadRequest extends S3Request implements ToCopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateMultipartUploadRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ObjectCannedACL |
acl()
The canned ACL to apply to the object.
|
String |
aclAsString()
The canned ACL to apply to the object.
|
String |
bucket()
The name of the bucket to which to initiate the upload
|
Boolean |
bucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Key Management Service (KMS) keys (SSE-KMS).
|
static CreateMultipartUploadRequest.Builder |
builder() |
String |
cacheControl()
Specifies caching behavior along the request/reply chain.
|
ChecksumAlgorithm |
checksumAlgorithm()
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object.
|
String |
checksumAlgorithmAsString()
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object.
|
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.
|
String |
contentType()
A standard MIME type describing the format of the object data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
Instant |
expires()
The date and time at which the object is no longer cacheable.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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() |
boolean |
hasMetadata()
For responses, this returns true if the service returned a value for the Metadata property.
|
String |
key()
Object key for which the multipart upload is to be initiated.
|
Map<String,String> |
metadata()
A map of metadata to store with the object in S3.
|
ObjectLockLegalHoldStatus |
objectLockLegalHoldStatus()
Specifies whether you want to apply a legal hold to the uploaded object.
|
String |
objectLockLegalHoldStatusAsString()
Specifies whether you want to apply a legal hold to the uploaded object.
|
ObjectLockMode |
objectLockMode()
Specifies the Object Lock mode that you want to apply to the uploaded object.
|
String |
objectLockModeAsString()
Specifies the Object Lock mode that you want to apply to the uploaded object.
|
Instant |
objectLockRetainUntilDate()
Specifies the date and time when you want the Object Lock to expire.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateMultipartUploadRequest.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256 , aws:kms ). |
String |
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256 , aws:kms ). |
String |
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, 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 |
ssekmsEncryptionContext()
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption.
|
String |
ssekmsKeyId()
Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for
object encryption.
|
StorageClass |
storageClass()
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
|
String |
storageClassAsString()
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
|
String |
tagging()
The tag-set for the object.
|
CreateMultipartUploadRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
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.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final ObjectCannedACL acl()
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
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
aclAsString()
.
This action is not supported by Amazon S3 on Outposts.
ObjectCannedACL
public final String aclAsString()
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
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
aclAsString()
.
This action is not supported by Amazon S3 on Outposts.
ObjectCannedACL
public final String bucket()
The name of the bucket to which to initiate the upload
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the
Amazon S3 User Guide.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
see What is S3 on
Outposts? in the Amazon S3 User Guide.
public final String cacheControl()
Specifies caching behavior along the request/reply chain.
public final String contentDisposition()
Specifies presentational information for the object.
public final 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.
public final String contentLanguage()
The language the content is in.
public final String contentType()
A standard MIME type describing the format of the object data.
public final Instant expires()
The date and time at which the object is no longer cacheable.
public final String grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantRead()
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantReadACP()
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantWriteACP()
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String key()
Object key for which the multipart upload is to be initiated.
public final boolean hasMetadata()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,String> metadata()
A map of metadata to store with the object in S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMetadata()
method.
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
).
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 serverSideEncryptionAsString()
.
AES256
, aws:kms
).ServerSideEncryption
public final String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
).
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 serverSideEncryptionAsString()
.
AES256
, aws:kms
).ServerSideEncryption
public final StorageClass storageClass()
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
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
storageClassAsString()
.
StorageClass
public final String storageClassAsString()
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
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
storageClassAsString()
.
StorageClass
public final 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. Amazon S3 stores the value of this header in the object metadata.
public final String sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
public final String sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to
store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.
x-amz-server-side-encryption-customer-algorithm
header.public final String sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
public final String ssekmsKeyId()
Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
public final String ssekmsEncryptionContext()
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
public final Boolean bucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Key Management Service (KMS) keys (SSE-KMS). Setting this header to true
causes Amazon S3 to use an
S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
true
causes Amazon
S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
public final 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
requestPayerAsString()
.
RequestPayer
public final String requestPayerAsString()
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
requestPayerAsString()
.
RequestPayer
public final String tagging()
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
public final ObjectLockMode objectLockMode()
Specifies the Object Lock mode that you want to apply to the uploaded object.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public final String objectLockModeAsString()
Specifies the Object Lock mode that you want to apply to the uploaded object.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public final Instant objectLockRetainUntilDate()
Specifies the date and time when you want the Object Lock to expire.
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Specifies whether you want to apply a legal hold to the uploaded object.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public final String objectLockLegalHoldStatusAsString()
Specifies whether you want to apply a legal hold to the uploaded object.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public final String expectedBucketOwner()
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
403 Forbidden
(access denied).public final ChecksumAlgorithm checksumAlgorithm()
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
ChecksumAlgorithm
public final String checksumAlgorithmAsString()
Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
ChecksumAlgorithm
public CreateMultipartUploadRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>
toBuilder
in class S3Request
public static CreateMultipartUploadRequest.Builder builder()
public static Class<? extends CreateMultipartUploadRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.