java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.RenameObjectRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RenameObjectRequest.Builder,RenameObjectRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RenameObjectRequest
extends S3Request
implements ToCopyableBuilder<RenameObjectRequest.Builder,RenameObjectRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RenameObjectRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bucket()`	The bucket name of the directory bucket containing the object.
`static RenameObjectRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.
`String`	`destinationIfMatch()`	Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3.
`Instant`	`destinationIfModifiedSince()`	Renames the object if the destination exists and if it has been modified since the specified time.
`String`	`destinationIfNoneMatch()`	Renames the object only if the destination does not already exist in the specified directory bucket.
`Instant`	`destinationIfUnmodifiedSince()`	Renames the object if it hasn't been modified since the specified time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`key()`	Key name of the object to rename.
`String`	`renameSource()`	Specifies the source for the rename operation.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RenameObjectRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceIfMatch()`	Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
`Instant`	`sourceIfModifiedSince()`	Renames the object if the source exists and if it has been modified since the specified time.
`String`	`sourceIfNoneMatch()`	Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag.
`Instant`	`sourceIfUnmodifiedSince()`	Renames the object if the source exists and hasn't been modified since the specified time.
`RenameObjectRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - bucket
```
public final String bucket()
```
    The bucket name of the directory bucket containing the object.
    
    You must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.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--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
    
    Returns:
    
    The bucket name of the directory bucket containing the object.
    
    You must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.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--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
  - key
```
public final String key()
```
    Key name of the object to rename.
    
    Returns:
    
    Key name of the object to rename.
  - renameSource
```
public final String renameSource()
```
    Specifies the source for the rename operation. The value must be URL encoded.
    
    Returns:
    
    Specifies the source for the rename operation. The value must be URL encoded.
  - destinationIfMatch
```
public final String destinationIfMatch()
```
    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.
    
    Expects the ETag value as a string.
    
    Returns:
    
    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.
    
    Expects the ETag value as a string.
  - destinationIfNoneMatch
```
public final String destinationIfNoneMatch()
```
    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.
    
    Expects the * character (asterisk).
    
    Returns:
    
    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.
    
    Expects the * character (asterisk).
  - destinationIfModifiedSince
```
public final Instant destinationIfModifiedSince()
```
    Renames the object if the destination exists and if it has been modified since the specified time.
    
    Returns:
    
    Renames the object if the destination exists and if it has been modified since the specified time.
  - destinationIfUnmodifiedSince
```
public final Instant destinationIfUnmodifiedSince()
```
    Renames the object if it hasn't been modified since the specified time.
    
    Returns:
    
    Renames the object if it hasn't been modified since the specified time.
  - sourceIfMatch
```
public final String sourceIfMatch()
```
    Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
    
    Returns:
    
    Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
  - sourceIfNoneMatch
```
public final String sourceIfNoneMatch()
```
    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.
    
    Returns:
    
    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.
  - sourceIfModifiedSince
```
public final Instant sourceIfModifiedSince()
```
    Renames the object if the source exists and if it has been modified since the specified time.
    
    Returns:
    
    Renames the object if the source exists and if it has been modified since the specified time.
  - sourceIfUnmodifiedSince
```
public final Instant sourceIfUnmodifiedSince()
```
    Renames the object if the source exists and hasn't been modified since the specified time.
    
    Returns:
    
    Renames the object if the source exists and hasn't been modified since the specified time.
  - clientToken
```
public final String clientToken()
```
    A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.
    
    RenameObject supports idempotency using a client token. To make an idempotent API request using RenameObject, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an IdempotentParameterMismatch error is returned.
    
    Returns:
    
    A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.
    
    RenameObject supports idempotency using a client token. To make an idempotent API request using RenameObject, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an IdempotentParameterMismatch error is returned.
  - toBuilder
```
public RenameObjectRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RenameObjectRequest.Builder,RenameObjectRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static RenameObjectRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RenameObjectRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class RenameObjectRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

bucket

key

renameSource

destinationIfMatch

destinationIfNoneMatch

destinationIfModifiedSince

destinationIfUnmodifiedSince

sourceIfMatch

sourceIfNoneMatch

sourceIfModifiedSince

sourceIfUnmodifiedSince

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField