s3/aws.sdk.kotlin.services.s3.model/RenameObjectRequest

RenameObjectRequest

class RenameObjectRequest

Types

Builder

class Builder

Companion

object Companion

Properties

bucket

val bucket: String?

The bucket name of the directory bucket containing the object.

clientToken

val clientToken: String?

A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.

destinationIfMatch

val destinationIfMatch: String?

Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3. The If-Match header field makes the request method conditional on ETags. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

destinationIfModifiedSince

val destinationIfModifiedSince: Instant?

Renames the object if the destination exists and if it has been modified since the specified time.

destinationIfNoneMatch

val destinationIfNoneMatch: String?

Renames the object only if the destination does not already exist in the specified directory bucket. If the object does exist when you send a request with If-None-Match:*, the S3 API will return a 412 Precondition Failed error, preventing an overwrite. The If-None-Match header prevents overwrites of existing data by validating that there's not an object with the same key name already in your directory bucket.

destinationIfUnmodifiedSince

val destinationIfUnmodifiedSince: Instant?

Renames the object if it hasn't been modified since the specified time.

key

val key: String?

Key name of the object to rename.

renameSource

val renameSource: String?

Specifies the source for the rename operation. The value must be URL encoded.

sourceIfMatch

val sourceIfMatch: String?

Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.

sourceIfModifiedSince

val sourceIfModifiedSince: Instant?

Renames the object if the source exists and if it has been modified since the specified time.

sourceIfNoneMatch

val sourceIfNoneMatch: String?

Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag. If an asterisk (*) character is provided, the operation will fail and return a 412 Precondition Failed error.

sourceIfUnmodifiedSince

val sourceIfUnmodifiedSince: Instant?

Renames the object if the source exists and hasn't been modified since the specified time.

Functions

copy

inline fun copy(block: RenameObjectRequest.Builder.() -> Unit = {}): RenameObjectRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String