Package software.amazon.awssdk.services.s3.model

Interface RenameObjectRequest.Builder

    • Method Detail

      • bucket

        RenameObjectRequest.Builder bucket​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • key

        RenameObjectRequest.Builder key​(String key)

        Key name of the object to rename.

        Parameters:
        key - Key name of the object to rename.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • renameSource

        RenameObjectRequest.Builder renameSource​(String renameSource)

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

        Parameters:
        renameSource - Specifies the source for the rename operation. The value must be URL encoded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationIfMatch

        RenameObjectRequest.Builder destinationIfMatch​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • destinationIfNoneMatch

        RenameObjectRequest.Builder destinationIfNoneMatch​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • destinationIfModifiedSince

        RenameObjectRequest.Builder destinationIfModifiedSince​(Instant destinationIfModifiedSince)

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

        Parameters:
        destinationIfModifiedSince - Renames the object if the destination exists and if it has been modified since the specified time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationIfUnmodifiedSince

        RenameObjectRequest.Builder destinationIfUnmodifiedSince​(Instant destinationIfUnmodifiedSince)

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

        Parameters:
        destinationIfUnmodifiedSince - Renames the object if it hasn't been modified since the specified time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIfMatch

        RenameObjectRequest.Builder sourceIfMatch​(String sourceIfMatch)

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

        Parameters:
        sourceIfMatch - Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIfNoneMatch

        RenameObjectRequest.Builder sourceIfNoneMatch​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIfModifiedSince

        RenameObjectRequest.Builder sourceIfModifiedSince​(Instant sourceIfModifiedSince)

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

        Parameters:
        sourceIfModifiedSince - Renames the object if the source exists and if it has been modified since the specified time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIfUnmodifiedSince

        RenameObjectRequest.Builder sourceIfUnmodifiedSince​(Instant sourceIfUnmodifiedSince)

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

        Parameters:
        sourceIfUnmodifiedSince - Renames the object if the source exists and hasn't been modified since the specified time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        RenameObjectRequest.Builder clientToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.