commonMain.aws.sdk.kotlin.services.s3.model.GetObjectAttributesRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.s3.model
public class GetObjectAttributesRequest private constructor(builder: Builder) {
/**
* The name of the bucket that contains the object.
*
* **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
/**
* 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
/**
* The object key.
*/
public val key: kotlin.String? = builder.key
/**
* Sets the maximum number of parts to return.
*/
public val maxParts: kotlin.Int? = builder.maxParts
/**
* Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
*/
public val objectAttributes: List? = builder.objectAttributes
/**
* Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
*/
public val partNumberMarker: kotlin.String? = builder.partNumberMarker
/**
* 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
/**
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerAlgorithm: kotlin.String? = builder.sseCustomerAlgorithm
/**
* 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.
*/
public val sseCustomerKey: kotlin.String? = builder.sseCustomerKey
/**
* 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.
*/
public val sseCustomerKeyMd5: kotlin.String? = builder.sseCustomerKeyMd5
/**
* The version ID used to reference a specific version of the object.
*
* S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the `null` value of the version ID is supported by directory buckets. You can only specify `null` to the `versionId` query parameter in the request.
*/
public val versionId: kotlin.String? = builder.versionId
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.s3.model.GetObjectAttributesRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("GetObjectAttributesRequest(")
append("bucket=$bucket,")
append("expectedBucketOwner=$expectedBucketOwner,")
append("key=$key,")
append("maxParts=$maxParts,")
append("objectAttributes=$objectAttributes,")
append("partNumberMarker=$partNumberMarker,")
append("requestPayer=$requestPayer,")
append("sseCustomerAlgorithm=$sseCustomerAlgorithm,")
append("sseCustomerKey=*** Sensitive Data Redacted ***,")
append("sseCustomerKeyMd5=$sseCustomerKeyMd5,")
append("versionId=$versionId")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = bucket?.hashCode() ?: 0
result = 31 * result + (expectedBucketOwner?.hashCode() ?: 0)
result = 31 * result + (key?.hashCode() ?: 0)
result = 31 * result + (maxParts ?: 0)
result = 31 * result + (objectAttributes?.hashCode() ?: 0)
result = 31 * result + (partNumberMarker?.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 + (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 GetObjectAttributesRequest
if (bucket != other.bucket) return false
if (expectedBucketOwner != other.expectedBucketOwner) return false
if (key != other.key) return false
if (maxParts != other.maxParts) return false
if (objectAttributes != other.objectAttributes) return false
if (partNumberMarker != other.partNumberMarker) 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 (versionId != other.versionId) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.s3.model.GetObjectAttributesRequest = Builder(this).apply(block).build()
public class Builder {
/**
* The name of the bucket that contains the object.
*
* **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
/**
* 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
/**
* The object key.
*/
public var key: kotlin.String? = null
/**
* Sets the maximum number of parts to return.
*/
public var maxParts: kotlin.Int? = null
/**
* Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
*/
public var objectAttributes: List? = null
/**
* Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
*/
public var partNumberMarker: 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
/**
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerAlgorithm: kotlin.String? = null
/**
* 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.
*/
public var sseCustomerKey: kotlin.String? = null
/**
* 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.
*/
public var sseCustomerKeyMd5: kotlin.String? = null
/**
* The version ID used to reference a specific version of the object.
*
* S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the `null` value of the version ID is supported by directory buckets. You can only specify `null` to the `versionId` query parameter in the request.
*/
public var versionId: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.s3.model.GetObjectAttributesRequest) : this() {
this.bucket = x.bucket
this.expectedBucketOwner = x.expectedBucketOwner
this.key = x.key
this.maxParts = x.maxParts
this.objectAttributes = x.objectAttributes
this.partNumberMarker = x.partNumberMarker
this.requestPayer = x.requestPayer
this.sseCustomerAlgorithm = x.sseCustomerAlgorithm
this.sseCustomerKey = x.sseCustomerKey
this.sseCustomerKeyMd5 = x.sseCustomerKeyMd5
this.versionId = x.versionId
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.s3.model.GetObjectAttributesRequest = GetObjectAttributesRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy