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

Interface UploadPartRequest.Builder

    • Method Detail

      • bucket

        UploadPartRequest.Builder bucket​(String bucket)

        The 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 - The 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.

      • contentLength

        UploadPartRequest.Builder contentLength​(Long contentLength)

        Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

        Parameters:
        contentLength - Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentMD5

        UploadPartRequest.Builder contentMD5​(String contentMD5)

        The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

        This functionality is not supported for directory buckets.

        Parameters:
        contentMD5 - The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

        This functionality is not supported for directory buckets.

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

      • checksumAlgorithm

        UploadPartRequest.Builder checksumAlgorithm​(String checksumAlgorithm)

        Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

        If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

        This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

        Parameters:
        checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

        If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

        This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

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

      • checksumAlgorithm

        UploadPartRequest.Builder checksumAlgorithm​(ChecksumAlgorithm checksumAlgorithm)

        Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

        If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

        This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

        Parameters:
        checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

        If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

        This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

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

      • checksumCRC32

        UploadPartRequest.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

        UploadPartRequest.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

        UploadPartRequest.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

        UploadPartRequest.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.

      • key

        UploadPartRequest.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.

      • partNumber

        UploadPartRequest.Builder partNumber​(Integer partNumber)

        Part number of part being uploaded. This is a positive integer between 1 and 10,000.

        Parameters:
        partNumber - Part number of part being uploaded. This is a positive integer between 1 and 10,000.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • uploadId

        UploadPartRequest.Builder uploadId​(String uploadId)

        Upload ID identifying the multipart upload whose part is being uploaded.

        Parameters:
        uploadId - Upload ID identifying the multipart upload whose part is being uploaded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerAlgorithm

        UploadPartRequest.Builder sseCustomerAlgorithm​(String sseCustomerAlgorithm)

        Specifies the algorithm to use when encrypting the object (for example, AES256).

        This functionality is not supported for directory buckets.

        Parameters:
        sseCustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example, AES256).

        This functionality is not supported for directory buckets.

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

      • sseCustomerKey

        UploadPartRequest.Builder sseCustomerKey​(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 must be the same encryption key specified in the initiate multipart upload request.

        This functionality is not supported for directory buckets.

        Parameters:
        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 must be the same encryption key specified in the initiate multipart upload request.

        This functionality is not supported for directory buckets.

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

      • sseCustomerKeyMD5

        UploadPartRequest.Builder sseCustomerKeyMD5​(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.

        This functionality is not supported for directory buckets.

        Parameters:
        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.

        This functionality is not supported for directory buckets.

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

      • requestPayer

        UploadPartRequest.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, RequestPayer

      • requestPayer

        UploadPartRequest.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:
        RequestPayer, RequestPayer

      • expectedBucketOwner

        UploadPartRequest.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.

      • sdkPartType

        UploadPartRequest.Builder sdkPartType​(String sdkPartType)
        Indicates whether the request is a last part or not. This field will not be included in the request payload.
        Parameters:
        sdkPartType - Indicates whether the request is a last part or not. This field will not be included in the request payload.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SdkPartType, SdkPartType

      • sdkPartType

        UploadPartRequest.Builder sdkPartType​(SdkPartType sdkPartType)
        Indicates whether the request is a last part or not. This field will not be included in the request payload.
        Parameters:
        sdkPartType - Indicates whether the request is a last part or not. This field will not be included in the request payload.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SdkPartType, SdkPartType