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

Interface UpdateObjectEncryptionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateObjectEncryptionRequest.Builder,UpdateObjectEncryptionRequest>, S3Request.Builder, SdkBuilder<UpdateObjectEncryptionRequest.Builder,UpdateObjectEncryptionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateObjectEncryptionRequest

@Mutable
@NotThreadSafe
public static interface UpdateObjectEncryptionRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<UpdateObjectEncryptionRequest.Builder,UpdateObjectEncryptionRequest>

Method Summary

Modifier and Type	Method	Description
UpdateObjectEncryptionRequest.Builder	bucket(String bucket)	The name of the general purpose bucket that contains the specified object key name.
UpdateObjectEncryptionRequest.Builder	checksumAlgorithm(String checksumAlgorithm)	Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK.
UpdateObjectEncryptionRequest.Builder	checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)	Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK.
UpdateObjectEncryptionRequest.Builder	contentMD5(String contentMD5)	The MD5 hash for the request body.
UpdateObjectEncryptionRequest.Builder	expectedBucketOwner(String expectedBucketOwner)	The account ID of the expected bucket owner.
UpdateObjectEncryptionRequest.Builder	key(String key)	The key name of the object that you want to update the server-side encryption type for.
default UpdateObjectEncryptionRequest.Builder	objectEncryption(Consumer<ObjectEncryption.Builder> objectEncryption)	The updated server-side encryption type for this object.
UpdateObjectEncryptionRequest.Builder	objectEncryption(ObjectEncryption objectEncryption)	The updated server-side encryption type for this object.
UpdateObjectEncryptionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateObjectEncryptionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateObjectEncryptionRequest.Builder	requestPayer(String requestPayer)	Sets the value of the RequestPayer property for this object.
UpdateObjectEncryptionRequest.Builder	requestPayer(RequestPayer requestPayer)	Sets the value of the RequestPayer property for this object.
UpdateObjectEncryptionRequest.Builder	versionId(String versionId)	The version ID of the object that you want to update the server-side encryption type for.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

bucket

UpdateObjectEncryptionRequest.Builder bucket(String bucket)

The name of the general purpose bucket that contains the specified object key name.

When you use this operation with an access point attached to a general purpose bucket, you must either provide the alias of the access point in place of the bucket name or you must specify the access point Amazon Resource Name (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 operation 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 Referencing access points in the Amazon S3 User Guide.

Parameters:

bucket - The name of the general purpose bucket that contains the specified object key name.

When you use this operation with an access point attached to a general purpose bucket, you must either provide the alias of the access point in place of the bucket name or you must specify the access point Amazon Resource Name (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 operation 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 Referencing access points in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

key

UpdateObjectEncryptionRequest.Builder key(String key)

The key name of the object that you want to update the server-side encryption type for.

Parameters:

key - The key name of the object that you want to update the server-side encryption type for.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionId

UpdateObjectEncryptionRequest.Builder versionId(String versionId)

The version ID of the object that you want to update the server-side encryption type for.

Parameters:

versionId - The version ID of the object that you want to update the server-side encryption type for.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectEncryption

UpdateObjectEncryptionRequest.Builder objectEncryption(ObjectEncryption objectEncryption)

The updated server-side encryption type for this object. The UpdateObjectEncryption operation supports the SSE-S3 and SSE-KMS encryption types.

Valid Values: SSES3 | SSEKMS

Parameters:

objectEncryption - The updated server-side encryption type for this object. The UpdateObjectEncryption operation supports the SSE-S3 and SSE-KMS encryption types.

Valid Values: SSES3 | SSEKMS

Returns:

Returns a reference to this object so that method calls can be chained together.

objectEncryption

default UpdateObjectEncryptionRequest.Builder objectEncryption(Consumer<ObjectEncryption.Builder> objectEncryption)

The updated server-side encryption type for this object. The UpdateObjectEncryption operation supports the SSE-S3 and SSE-KMS encryption types.

Valid Values: SSES3 | SSEKMS

This is a convenience method that creates an instance of the ObjectEncryption.Builder avoiding the need to create one manually via ObjectEncryption.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to objectEncryption(ObjectEncryption).

Parameters:

objectEncryption - a consumer that will call methods on ObjectEncryption.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

objectEncryption(ObjectEncryption)

requestPayer

UpdateObjectEncryptionRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

requestPayer

UpdateObjectEncryptionRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

expectedBucketOwner

UpdateObjectEncryptionRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected bucket owner. If the account ID that you provide doesn't match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Parameters:

expectedBucketOwner - The account ID of the expected bucket owner. If the account ID that you provide doesn't match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

Returns a reference to this object so that method calls can be chained together.

contentMD5

UpdateObjectEncryptionRequest.Builder contentMD5(String contentMD5)

The MD5 hash for the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Parameters:

contentMD5 - The MD5 hash for the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Returns:

Returns a reference to this object so that method calls can be chained together.

checksumAlgorithm

UpdateObjectEncryptionRequest.Builder checksumAlgorithm(String checksumAlgorithm)

Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK. This header doesn't 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 in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Parameters:

checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK. This header doesn't 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 in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChecksumAlgorithm, ChecksumAlgorithm

checksumAlgorithm

UpdateObjectEncryptionRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK. This header doesn't 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 in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Parameters:

checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK. This header doesn't 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 in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChecksumAlgorithm, ChecksumAlgorithm

overrideConfiguration

UpdateObjectEncryptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateObjectEncryptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder