commonMain.aws.sdk.kotlin.services.s3.model.CompleteMultipartUploadRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.s3.model
public class CompleteMultipartUploadRequest private constructor(builder: Builder) {
/**
* 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-az2--x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) 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?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the *Amazon S3 User Guide*.
*/
public val bucket: kotlin.String? = builder.bucket
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumCrc32: kotlin.String? = builder.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 CRC32C checksum of the object. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumCrc32C: kotlin.String? = builder.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, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumSha1: kotlin.String? = builder.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, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumSha256: kotlin.String? = builder.checksumSha256
/**
* 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).
*/
public val expectedBucketOwner: kotlin.String? = builder.expectedBucketOwner
/**
* Object key for which the multipart upload was initiated.
*/
public val key: kotlin.String? = builder.key
/**
* The container for the multipart upload request information.
*/
public val multipartUpload: aws.sdk.kotlin.services.s3.model.CompletedMultipartUpload? = builder.multipartUpload
/**
* Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val requestPayer: aws.sdk.kotlin.services.s3.model.RequestPayer? = builder.requestPayer
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerAlgorithm: kotlin.String? = builder.sseCustomerAlgorithm
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerKey: kotlin.String? = builder.sseCustomerKey
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerKeyMd5: kotlin.String? = builder.sseCustomerKeyMd5
/**
* ID for the initiated multipart upload.
*/
public val uploadId: kotlin.String? = builder.uploadId
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.s3.model.CompleteMultipartUploadRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CompleteMultipartUploadRequest(")
append("bucket=$bucket,")
append("checksumCrc32=$checksumCrc32,")
append("checksumCrc32C=$checksumCrc32C,")
append("checksumSha1=$checksumSha1,")
append("checksumSha256=$checksumSha256,")
append("expectedBucketOwner=$expectedBucketOwner,")
append("key=$key,")
append("multipartUpload=$multipartUpload,")
append("requestPayer=$requestPayer,")
append("sseCustomerAlgorithm=$sseCustomerAlgorithm,")
append("sseCustomerKey=*** Sensitive Data Redacted ***,")
append("sseCustomerKeyMd5=$sseCustomerKeyMd5,")
append("uploadId=$uploadId")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = bucket?.hashCode() ?: 0
result = 31 * result + (checksumCrc32?.hashCode() ?: 0)
result = 31 * result + (checksumCrc32C?.hashCode() ?: 0)
result = 31 * result + (checksumSha1?.hashCode() ?: 0)
result = 31 * result + (checksumSha256?.hashCode() ?: 0)
result = 31 * result + (expectedBucketOwner?.hashCode() ?: 0)
result = 31 * result + (key?.hashCode() ?: 0)
result = 31 * result + (multipartUpload?.hashCode() ?: 0)
result = 31 * result + (requestPayer?.hashCode() ?: 0)
result = 31 * result + (sseCustomerAlgorithm?.hashCode() ?: 0)
result = 31 * result + (sseCustomerKey?.hashCode() ?: 0)
result = 31 * result + (sseCustomerKeyMd5?.hashCode() ?: 0)
result = 31 * result + (uploadId?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CompleteMultipartUploadRequest
if (bucket != other.bucket) return false
if (checksumCrc32 != other.checksumCrc32) return false
if (checksumCrc32C != other.checksumCrc32C) return false
if (checksumSha1 != other.checksumSha1) return false
if (checksumSha256 != other.checksumSha256) return false
if (expectedBucketOwner != other.expectedBucketOwner) return false
if (key != other.key) return false
if (multipartUpload != other.multipartUpload) return false
if (requestPayer != other.requestPayer) return false
if (sseCustomerAlgorithm != other.sseCustomerAlgorithm) return false
if (sseCustomerKey != other.sseCustomerKey) return false
if (sseCustomerKeyMd5 != other.sseCustomerKeyMd5) return false
if (uploadId != other.uploadId) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.s3.model.CompleteMultipartUploadRequest = Builder(this).apply(block).build()
public class Builder {
/**
* 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-az2--x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) 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?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the *Amazon S3 User Guide*.
*/
public var bucket: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumCrc32: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumCrc32C: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumSha1: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumSha256: kotlin.String? = null
/**
* 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).
*/
public var expectedBucketOwner: kotlin.String? = null
/**
* Object key for which the multipart upload was initiated.
*/
public var key: kotlin.String? = null
/**
* The container for the multipart upload request information.
*/
public var multipartUpload: aws.sdk.kotlin.services.s3.model.CompletedMultipartUpload? = null
/**
* Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var requestPayer: aws.sdk.kotlin.services.s3.model.RequestPayer? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerAlgorithm: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerKey: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerKeyMd5: kotlin.String? = null
/**
* ID for the initiated multipart upload.
*/
public var uploadId: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.s3.model.CompleteMultipartUploadRequest) : this() {
this.bucket = x.bucket
this.checksumCrc32 = x.checksumCrc32
this.checksumCrc32C = x.checksumCrc32C
this.checksumSha1 = x.checksumSha1
this.checksumSha256 = x.checksumSha256
this.expectedBucketOwner = x.expectedBucketOwner
this.key = x.key
this.multipartUpload = x.multipartUpload
this.requestPayer = x.requestPayer
this.sseCustomerAlgorithm = x.sseCustomerAlgorithm
this.sseCustomerKey = x.sseCustomerKey
this.sseCustomerKeyMd5 = x.sseCustomerKeyMd5
this.uploadId = x.uploadId
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.s3.model.CompleteMultipartUploadRequest = CompleteMultipartUploadRequest(this)
/**
* construct an [aws.sdk.kotlin.services.s3.model.CompletedMultipartUpload] inside the given [block]
*/
public fun multipartUpload(block: aws.sdk.kotlin.services.s3.model.CompletedMultipartUpload.Builder.() -> kotlin.Unit) {
this.multipartUpload = aws.sdk.kotlin.services.s3.model.CompletedMultipartUpload.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy