Package software.amazon.awssdk.services.s3.model

Interface CompleteMultipartUploadRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CompleteMultipartUploadRequest.Builder,CompleteMultipartUploadRequest>, S3Request.Builder, SdkBuilder<CompleteMultipartUploadRequest.Builder,CompleteMultipartUploadRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CompleteMultipartUploadRequest
public static interface CompleteMultipartUploadRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<CompleteMultipartUploadRequest.Builder,CompleteMultipartUploadRequest>

  • Method Details

    • bucket

      CompleteMultipartUploadRequest.Builder bucket(String bucket)

      Name of the bucket to which the multipart upload was initiated.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.

      Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - 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.

      Parameters:
      bucket - Name of the bucket to which the multipart upload was initiated.

      Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.

      Access points and Object Lambda access points are not supported by directory buckets.

      S3 on Outposts - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

      CompleteMultipartUploadRequest.Builder key(String key)

      Object key for which the multipart upload was initiated.

      Parameters:
      key - Object key for which the multipart upload was initiated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multipartUpload

      CompleteMultipartUploadRequest.Builder multipartUpload(CompletedMultipartUpload multipartUpload)

      The container for the multipart upload request information.

      Parameters:
      multipartUpload - The container for the multipart upload request information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multipartUpload

      default CompleteMultipartUploadRequest.Builder multipartUpload(Consumer<CompletedMultipartUpload.Builder> multipartUpload)

      The container for the multipart upload request information.

      This is a convenience method that creates an instance of the CompletedMultipartUpload.Builder avoiding the need to create one manually via CompletedMultipartUpload.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multipartUpload(CompletedMultipartUpload).

      Parameters:
      multipartUpload - a consumer that will call methods on CompletedMultipartUpload.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • uploadId

      CompleteMultipartUploadRequest.Builder uploadId(String uploadId)

      ID for the initiated multipart upload.

      Parameters:
      uploadId - ID for the initiated multipart upload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumCRC32

      CompleteMultipartUploadRequest.Builder checksumCRC32(String checksumCRC32)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumCRC32 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumCRC32C

      CompleteMultipartUploadRequest.Builder checksumCRC32C(String checksumCRC32C)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumCRC32C - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA1

      CompleteMultipartUploadRequest.Builder checksumSHA1(String checksumSHA1)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumSHA1 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA256

      CompleteMultipartUploadRequest.Builder checksumSHA256(String checksumSHA256)

      This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumSHA256 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestPayer

      CompleteMultipartUploadRequest.Builder requestPayer(String requestPayer)
      Sets the value of the RequestPayer property for this object.
      Parameters:
      requestPayer - The new value for the RequestPayer property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestPayer

      CompleteMultipartUploadRequest.Builder requestPayer(RequestPayer requestPayer)
      Sets the value of the RequestPayer property for this object.
      Parameters:
      requestPayer - The new value for the RequestPayer property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedBucketOwner

      CompleteMultipartUploadRequest.Builder expectedBucketOwner(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerAlgorithm

      CompleteMultipartUploadRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

      The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      Parameters:
      sseCustomerAlgorithm - The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerKey

      CompleteMultipartUploadRequest.Builder sseCustomerKey(String sseCustomerKey)

      The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      Parameters:
      sseCustomerKey - The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerKeyMD5

      CompleteMultipartUploadRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

      The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      Parameters:
      sseCustomerKeyMD5 - The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CompleteMultipartUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CompleteMultipartUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.