commonMain.aws.sdk.kotlin.services.s3.model.PutObjectAclRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.s3.model
public class PutObjectAclRequest private constructor(builder: Builder) {
/**
* Contains the elements that set the ACL permissions for an object per grantee.
*/
public val accessControlPolicy: aws.sdk.kotlin.services.s3.model.AccessControlPolicy? = builder.accessControlPolicy
/**
* The canned ACL to apply to the object. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*/
public val acl: aws.sdk.kotlin.services.s3.model.ObjectCannedAcl? = builder.acl
/**
* The bucket name that contains the object to which you want to attach the ACL.
*
* **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*.
*
* **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
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*
* If you provide an individual checksum, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter.
*/
public val checksumAlgorithm: aws.sdk.kotlin.services.s3.model.ChecksumAlgorithm? = builder.checksumAlgorithm
/**
* The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to [RFC 1864.>](http://www.ietf.org/rfc/rfc1864.txt)
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
*/
public val contentMd5: kotlin.String? = builder.contentMd5
/**
* 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
/**
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantFullControl: kotlin.String? = builder.grantFullControl
/**
* Allows grantee to list the objects in the bucket.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantRead: kotlin.String? = builder.grantRead
/**
* Allows grantee to read the bucket ACL.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantReadAcp: kotlin.String? = builder.grantReadAcp
/**
* Allows grantee to create new objects in the bucket.
*
* For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
*/
public val grantWrite: kotlin.String? = builder.grantWrite
/**
* Allows grantee to write the ACL for the applicable bucket.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantWriteAcp: kotlin.String? = builder.grantWriteAcp
/**
* Key for which the PUT action was initiated.
*/
public val key: kotlin.String? = builder.key
/**
* 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
/**
* Version ID used to reference a specific version of the object.
*
* This functionality is not supported for directory buckets.
*/
public val versionId: kotlin.String? = builder.versionId
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.s3.model.PutObjectAclRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("PutObjectAclRequest(")
append("accessControlPolicy=$accessControlPolicy,")
append("acl=$acl,")
append("bucket=$bucket,")
append("checksumAlgorithm=$checksumAlgorithm,")
append("contentMd5=$contentMd5,")
append("expectedBucketOwner=$expectedBucketOwner,")
append("grantFullControl=$grantFullControl,")
append("grantRead=$grantRead,")
append("grantReadAcp=$grantReadAcp,")
append("grantWrite=$grantWrite,")
append("grantWriteAcp=$grantWriteAcp,")
append("key=$key,")
append("requestPayer=$requestPayer,")
append("versionId=$versionId")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = accessControlPolicy?.hashCode() ?: 0
result = 31 * result + (acl?.hashCode() ?: 0)
result = 31 * result + (bucket?.hashCode() ?: 0)
result = 31 * result + (checksumAlgorithm?.hashCode() ?: 0)
result = 31 * result + (contentMd5?.hashCode() ?: 0)
result = 31 * result + (expectedBucketOwner?.hashCode() ?: 0)
result = 31 * result + (grantFullControl?.hashCode() ?: 0)
result = 31 * result + (grantRead?.hashCode() ?: 0)
result = 31 * result + (grantReadAcp?.hashCode() ?: 0)
result = 31 * result + (grantWrite?.hashCode() ?: 0)
result = 31 * result + (grantWriteAcp?.hashCode() ?: 0)
result = 31 * result + (key?.hashCode() ?: 0)
result = 31 * result + (requestPayer?.hashCode() ?: 0)
result = 31 * result + (versionId?.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 PutObjectAclRequest
if (accessControlPolicy != other.accessControlPolicy) return false
if (acl != other.acl) return false
if (bucket != other.bucket) return false
if (checksumAlgorithm != other.checksumAlgorithm) return false
if (contentMd5 != other.contentMd5) return false
if (expectedBucketOwner != other.expectedBucketOwner) return false
if (grantFullControl != other.grantFullControl) return false
if (grantRead != other.grantRead) return false
if (grantReadAcp != other.grantReadAcp) return false
if (grantWrite != other.grantWrite) return false
if (grantWriteAcp != other.grantWriteAcp) return false
if (key != other.key) return false
if (requestPayer != other.requestPayer) return false
if (versionId != other.versionId) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.s3.model.PutObjectAclRequest = Builder(this).apply(block).build()
public class Builder {
/**
* Contains the elements that set the ACL permissions for an object per grantee.
*/
public var accessControlPolicy: aws.sdk.kotlin.services.s3.model.AccessControlPolicy? = null
/**
* The canned ACL to apply to the object. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
*/
public var acl: aws.sdk.kotlin.services.s3.model.ObjectCannedAcl? = null
/**
* The bucket name that contains the object to which you want to attach the ACL.
*
* **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*.
*
* **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
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*
* If you provide an individual checksum, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter.
*/
public var checksumAlgorithm: aws.sdk.kotlin.services.s3.model.ChecksumAlgorithm? = null
/**
* The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to [RFC 1864.>](http://www.ietf.org/rfc/rfc1864.txt)
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
*/
public var contentMd5: 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
/**
* Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantFullControl: kotlin.String? = null
/**
* Allows grantee to list the objects in the bucket.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantRead: kotlin.String? = null
/**
* Allows grantee to read the bucket ACL.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantReadAcp: kotlin.String? = null
/**
* Allows grantee to create new objects in the bucket.
*
* For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
*/
public var grantWrite: kotlin.String? = null
/**
* Allows grantee to write the ACL for the applicable bucket.
*
* This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantWriteAcp: kotlin.String? = null
/**
* Key for which the PUT action was initiated.
*/
public var key: kotlin.String? = 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
/**
* Version ID used to reference a specific version of the object.
*
* This functionality is not supported for directory buckets.
*/
public var versionId: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.s3.model.PutObjectAclRequest) : this() {
this.accessControlPolicy = x.accessControlPolicy
this.acl = x.acl
this.bucket = x.bucket
this.checksumAlgorithm = x.checksumAlgorithm
this.contentMd5 = x.contentMd5
this.expectedBucketOwner = x.expectedBucketOwner
this.grantFullControl = x.grantFullControl
this.grantRead = x.grantRead
this.grantReadAcp = x.grantReadAcp
this.grantWrite = x.grantWrite
this.grantWriteAcp = x.grantWriteAcp
this.key = x.key
this.requestPayer = x.requestPayer
this.versionId = x.versionId
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.s3.model.PutObjectAclRequest = PutObjectAclRequest(this)
/**
* construct an [aws.sdk.kotlin.services.s3.model.AccessControlPolicy] inside the given [block]
*/
public fun accessControlPolicy(block: aws.sdk.kotlin.services.s3.model.AccessControlPolicy.Builder.() -> kotlin.Unit) {
this.accessControlPolicy = aws.sdk.kotlin.services.s3.model.AccessControlPolicy.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy