CreateMultipartUploadRequest (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.core.SdkRequest
- - com.ibm.cos.v2.awscore.AwsRequest
  - - com.ibm.cos.v2.services.s3.model.S3Request
    - - com.ibm.cos.v2.services.s3.model.CreateMultipartUploadRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>

@Generated(value="com.ibm.cos.v2:codegen")
public final class CreateMultipartUploadRequest
extends S3Request
implements ToCopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateMultipartUploadRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateMultipartUploadRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 where the multipart upload is initiated and where the object is uploaded.
`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 that you want Amazon S3 to use to create the checksum for the object.
`String`	`checksumAlgorithmAsString()` Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object.
`ChecksumType`	`checksumType()` Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
`String`	`checksumTypeAsString()` Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
`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 that 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)` Indicates whether some other object is "equal to" this one by SDK fields.
`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)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`String`	`grantFullControl()` Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
`String`	`grantRead()` Specify access permissions explicitly to allow grantee to read the object data and its metadata.
`String`	`grantReadACP()` Specify access permissions explicitly to allows grantee to read the object ACL.
`String`	`grantWriteACP()` Specify access permissions explicitly to allows grantee to allow 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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateMultipartUploadRequest.Builder>`	`serializableBuilderClass()`
`ServerSideEncryption`	`serverSideEncryption()` The server-side encryption algorithm used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`).
`String`	`serverSideEncryptionAsString()` The server-side encryption algorithm used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`).
`String`	`sseCustomerAlgorithm()` Specifies the algorithm to use 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 customer-provided 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 KMS key ID (Key ID, Key ARN, or Key Alias) 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()` Take this object and create a builder that contains all of the current property values of this object.
`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.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - acl
```
public final ObjectCannedACL acl()
```
    The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for 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().
    Returns:
    The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.
    
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
    See Also:
    
    ObjectCannedACL
  - aclAsString
```
public final String aclAsString()
```
    The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for 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().
    Returns:
    The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.
    
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
    See Also:
    
    ObjectCannedACL
  - bucket
```
public final String bucket()
```
    The name of the bucket where the multipart upload is initiated and where the object is uploaded.
    
    Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com . Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
    
    Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.
    
    Object Lambda access points are not supported by directory buckets.
    
    S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
    
    Returns:
    
    The name of the bucket where the multipart upload is initiated and where the object is uploaded.
    
    Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
    
    Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.
    
    Object Lambda access points are not supported by directory buckets.
    
    S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
  - cacheControl
```
public final String cacheControl()
```
    Specifies caching behavior along the request/reply chain.
    
    Returns:
    
    Specifies caching behavior along the request/reply chain.
  - contentDisposition
```
public final String contentDisposition()
```
    Specifies presentational information for the object.
    
    Returns:
    
    Specifies presentational information for the object.
  - contentEncoding
```
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.
    
    For directory buckets, only the aws-chunked value is supported in this header field.
    
    Returns:
    
    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.
    
    For directory buckets, only the aws-chunked value is supported in this header field.
  - contentLanguage
```
public final String contentLanguage()
```
    The language that the content is in.
    
    Returns:
    
    The language that the content is in.
  - contentType
```
public final String contentType()
```
    A standard MIME type describing the format of the object data.
    
    Returns:
    
    A standard MIME type describing the format of the object data.
  - expires
```
public final Instant expires()
```
    The date and time at which the object is no longer cacheable.
    
    Returns:
    
    The date and time at which the object is no longer cacheable.
  - grantFullControl
```
public final String grantFullControl()
```
    Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    - id – if the value specified is the canonical user ID of an Amazon Web Services account
    - uri – if you are granting permissions to a predefined group
    - emailAddress – if the value specified is the email address of an Amazon Web Services account
      
      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      
      US East (N. Virginia)
      
      US West (N. California)
      
      US West (Oregon)
      
      Asia Pacific (Singapore)
      
      Asia Pacific (Sydney)
      
      Asia Pacific (Tokyo)
      
      Europe (Ireland)
      
      South America (São Paulo)
      
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
    Returns:
    Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    
    id – if the value specified is the canonical user ID of an Amazon Web Services account
    
    uri – if you are granting permissions to a predefined group
    
    emailAddress – if the value specified is the email address of an Amazon Web Services account
    
    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
    
    US East (N. Virginia)
    
    US West (N. California)
    
    US West (Oregon)
    
    Asia Pacific (Singapore)
    
    Asia Pacific (Sydney)
    
    Asia Pacific (Tokyo)
    
    Europe (Ireland)
    
    South America (São Paulo)
    
    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
  - grantRead
```
public final String grantRead()
```
    Specify access permissions explicitly to allow grantee to read the object data and its metadata.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    - id – if the value specified is the canonical user ID of an Amazon Web Services account
    - uri – if you are granting permissions to a predefined group
    - emailAddress – if the value specified is the email address of an Amazon Web Services account
      
      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      
      US East (N. Virginia)
      
      US West (N. California)
      
      US West (Oregon)
      
      Asia Pacific (Singapore)
      
      Asia Pacific (Sydney)
      
      Asia Pacific (Tokyo)
      
      Europe (Ireland)
      
      South America (São Paulo)
      
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
    Returns:
    Specify access permissions explicitly to allow grantee to read the object data and its metadata.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    
    id – if the value specified is the canonical user ID of an Amazon Web Services account
    
    uri – if you are granting permissions to a predefined group
    
    emailAddress – if the value specified is the email address of an Amazon Web Services account
    
    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
    
    US East (N. Virginia)
    
    US West (N. California)
    
    US West (Oregon)
    
    Asia Pacific (Singapore)
    
    Asia Pacific (Sydney)
    
    Asia Pacific (Tokyo)
    
    Europe (Ireland)
    
    South America (São Paulo)
    
    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
  - grantReadACP
```
public final String grantReadACP()
```
    Specify access permissions explicitly to allows grantee to read the object ACL.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    - id – if the value specified is the canonical user ID of an Amazon Web Services account
    - uri – if you are granting permissions to a predefined group
    - emailAddress – if the value specified is the email address of an Amazon Web Services account
      
      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      
      US East (N. Virginia)
      
      US West (N. California)
      
      US West (Oregon)
      
      Asia Pacific (Singapore)
      
      Asia Pacific (Sydney)
      
      Asia Pacific (Tokyo)
      
      Europe (Ireland)
      
      South America (São Paulo)
      
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
    Returns:
    Specify access permissions explicitly to allows grantee to read the object ACL.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    
    id – if the value specified is the canonical user ID of an Amazon Web Services account
    
    uri – if you are granting permissions to a predefined group
    
    emailAddress – if the value specified is the email address of an Amazon Web Services account
    
    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
    
    US East (N. Virginia)
    
    US West (N. California)
    
    US West (Oregon)
    
    Asia Pacific (Singapore)
    
    Asia Pacific (Sydney)
    
    Asia Pacific (Tokyo)
    
    Europe (Ireland)
    
    South America (São Paulo)
    
    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
  - grantWriteACP
```
public final String grantWriteACP()
```
    Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    - id – if the value specified is the canonical user ID of an Amazon Web Services account
    - uri – if you are granting permissions to a predefined group
    - emailAddress – if the value specified is the email address of an Amazon Web Services account
      
      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
      
      US East (N. Virginia)
      
      US West (N. California)
      
      US West (Oregon)
      
      Asia Pacific (Singapore)
      
      Asia Pacific (Sydney)
      
      Asia Pacific (Tokyo)
      
      Europe (Ireland)
      
      South America (São Paulo)
      
      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
    Returns:
    Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
    
    By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
    
    You specify each grantee as a type=value pair, where the type is one of the following:
    
    id – if the value specified is the canonical user ID of an Amazon Web Services account
    
    uri – if you are granting permissions to a predefined group
    
    emailAddress – if the value specified is the email address of an Amazon Web Services account
    
    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
    
    US East (N. Virginia)
    
    US West (N. California)
    
    US West (Oregon)
    
    Asia Pacific (Singapore)
    
    Asia Pacific (Sydney)
    
    Asia Pacific (Tokyo)
    
    Europe (Ireland)
    
    South America (São Paulo)
    
    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
    
    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
    
    x-amz-grant-read: id="11112222333", id="444455556666"
    
    This functionality is not supported for directory buckets.
    
    This functionality is not supported for Amazon S3 on Outposts.
  - key
```
public final String key()
```
    Object key for which the multipart upload is to be initiated.
    
    Returns:
    
    Object key for which the multipart upload is to be initiated.
  - hasMetadata
```
public final boolean hasMetadata()
```
    For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - metadata
```
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.
    
    Returns:
    
    A map of metadata to store with the object in S3.
  - serverSideEncryption
```
public final ServerSideEncryption serverSideEncryption()
```
    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).
    - Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
      
      In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings ( x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
      
      When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
    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().
    Returns:
    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).
    
    Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
    
    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings ( x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
    
    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
    See Also:
    
    ServerSideEncryption
  - serverSideEncryptionAsString
```
public final String serverSideEncryptionAsString()
```
    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).
    - Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
      
      In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings ( x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
      
      When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
    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().
    Returns:
    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).
    
    Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
    
    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings ( x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
    
    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
    See Also:
    
    ServerSideEncryption
  - storageClass
```
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. For more information, see Storage Classes in the Amazon S3 User Guide.
    Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
    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().
    Returns:
    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. For more information, see Storage Classes in the Amazon S3 User Guide.
    
    Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
    See Also:
    
    StorageClass
  - storageClassAsString
```
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. For more information, see Storage Classes in the Amazon S3 User Guide.
    Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
    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().
    Returns:
    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. For more information, see Storage Classes in the Amazon S3 User Guide.
    
    Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
    See Also:
    
    StorageClass
  - websiteRedirectLocation
```
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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
  - sseCustomerAlgorithm
```
public final String sseCustomerAlgorithm()
```
    Specifies the algorithm to use when encrypting the object (for example, AES256).
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Specifies the algorithm to use when encrypting the object (for example, AES256).
    
    This functionality is not supported for directory buckets.
  - sseCustomerKey
```
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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
  - sseCustomerKeyMD5
```
public final String sseCustomerKeyMD5()
```
    Specifies the 128-bit MD5 digest of the customer-provided 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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Specifies the 128-bit MD5 digest of the customer-provided 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.
    
    This functionality is not supported for directory buckets.
  - ssekmsKeyId
```
public final String ssekmsKeyId()
```
    Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
    
    General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key ( aws/s3) to protect the data.
    
    Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the x-amz-server-side-encryption header to aws:kms. Then, the x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported. Incorrect key specification results in an HTTP 400 Bad Request error.
    
    Returns:
    
    Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
    
    General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.
    
    Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the x-amz-server-side-encryption header to aws:kms. Then, the x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported. Incorrect key specification results in an HTTP 400 Bad Request error.
  - ssekmsEncryptionContext
```
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 string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
    
    Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
    
    Returns:
    
    Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
    
    Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
  - bucketKeyEnabled
```
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).
    
    General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.
    
    Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
    
    Returns:
    
    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).
    
    General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.
    
    Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
  - requestPayer
```
public final RequestPayer requestPayer()
```
    Returns the value of the RequestPayer property for this object.
    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().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public final String requestPayerAsString()
```
    Returns the value of the RequestPayer property for this object.
    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().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - tagging
```
public final String tagging()
```
    The tag-set for the object. The tag-set must be encoded as URL Query parameters.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    The tag-set for the object. The tag-set must be encoded as URL Query parameters.
    
    This functionality is not supported for directory buckets.
  - objectLockMode
```
public final ObjectLockMode objectLockMode()
```
    Specifies the Object Lock mode that you want to apply to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    Specifies the Object Lock mode that you want to apply to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockMode
  - objectLockModeAsString
```
public final String objectLockModeAsString()
```
    Specifies the Object Lock mode that you want to apply to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    Specifies the Object Lock mode that you want to apply to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockMode
  - objectLockRetainUntilDate
```
public final Instant objectLockRetainUntilDate()
```
    Specifies the date and time when you want the Object Lock to expire.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Specifies the date and time when you want the Object Lock to expire.
    
    This functionality is not supported for directory buckets.
  - objectLockLegalHoldStatus
```
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
```
    Specifies whether you want to apply a legal hold to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    Specifies whether you want to apply a legal hold to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockLegalHoldStatus
  - objectLockLegalHoldStatusAsString
```
public final String objectLockLegalHoldStatusAsString()
```
    Specifies whether you want to apply a legal hold to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    Specifies whether you want to apply a legal hold to the uploaded object.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockLegalHoldStatus
  - expectedBucketOwner
```
public final String expectedBucketOwner()
```
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
    
    Returns:
    
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
  - checksumAlgorithm
```
public final ChecksumAlgorithm checksumAlgorithm()
```
    Indicates the algorithm that 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().
    
    Returns:
    
    Indicates the algorithm that 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.
    
    See Also:
    
    ChecksumAlgorithm
  - checksumAlgorithmAsString
```
public final String checksumAlgorithmAsString()
```
    Indicates the algorithm that 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().
    
    Returns:
    
    Indicates the algorithm that 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.
    
    See Also:
    
    ChecksumAlgorithm
  - checksumType
```
public final ChecksumType checksumType()
```
    Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. 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, checksumType will return ChecksumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumTypeAsString().
    
    Returns:
    
    Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    ChecksumType
  - checksumTypeAsString
```
public final String checksumTypeAsString()
```
    Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. 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, checksumType will return ChecksumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumTypeAsString().
    
    Returns:
    
    Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    ChecksumType
  - toBuilder
```
public CreateMultipartUploadRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>
    
    Specified by:
    
    toBuilder in class S3Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateMultipartUploadRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateMultipartUploadRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo
    
    Returns:
    
    The mapping between the field name and its corresponding field.

Class CreateMultipartUploadRequest

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

Method Detail

acl

aclAsString

bucket

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentType

expires

grantFullControl

grantRead

grantReadACP

grantWriteACP

key

hasMetadata

metadata

serverSideEncryption

serverSideEncryptionAsString

storageClass

storageClassAsString

websiteRedirectLocation

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

ssekmsKeyId

ssekmsEncryptionContext

bucketKeyEnabled

requestPayer

requestPayerAsString

tagging

objectLockMode

objectLockModeAsString

objectLockRetainUntilDate

objectLockLegalHoldStatus

objectLockLegalHoldStatusAsString

expectedBucketOwner

checksumAlgorithm

checksumAlgorithmAsString

checksumType

checksumTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField