software.amazon.awssdk.services.s3.model

Interface PutObjectLegalHoldRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutObjectLegalHoldRequest

public static interface PutObjectLegalHoldRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>

Method Summary

Modifier and Type	Method and Description
PutObjectLegalHoldRequest.Builder	bucket(String bucket) The bucket name containing the object that you want to place a Legal Hold on.
PutObjectLegalHoldRequest.Builder	contentMD5(String contentMD5) The MD5 hash for the request body.
PutObjectLegalHoldRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account id of the expected bucket owner.
PutObjectLegalHoldRequest.Builder	key(String key) The key name for the object that you want to place a Legal Hold on.
default PutObjectLegalHoldRequest.Builder	legalHold(Consumer<ObjectLockLegalHold.Builder> legalHold) Container element for the Legal Hold configuration you want to apply to the specified object.
PutObjectLegalHoldRequest.Builder	legalHold(ObjectLockLegalHold legalHold) Container element for the Legal Hold configuration you want to apply to the specified object.
PutObjectLegalHoldRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutObjectLegalHoldRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutObjectLegalHoldRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
PutObjectLegalHoldRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
PutObjectLegalHoldRequest.Builder	versionId(String versionId) The version ID of the object that you want to place a Legal Hold on.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

bucket

PutObjectLegalHoldRequest.Builder bucket(String bucket)

The bucket name containing the object that you want to place a Legal Hold on.

When using this API with an access point, 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 AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucket - The bucket name containing the object that you want to place a Legal Hold on.

When using this API with an access point, 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 AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Returns:

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

key

PutObjectLegalHoldRequest.Builder key(String key)

The key name for the object that you want to place a Legal Hold on.

Parameters:

key - The key name for the object that you want to place a Legal Hold on.

Returns:

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

legalHold

PutObjectLegalHoldRequest.Builder legalHold(ObjectLockLegalHold legalHold)

Container element for the Legal Hold configuration you want to apply to the specified object.

Parameters:

legalHold - Container element for the Legal Hold configuration you want to apply to the specified object.

Returns:

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

legalHold

default PutObjectLegalHoldRequest.Builder legalHold(Consumer<ObjectLockLegalHold.Builder> legalHold)

Container element for the Legal Hold configuration you want to apply to the specified object.

This is a convenience that creates an instance of the ObjectLockLegalHold.Builder avoiding the need to create one manually via ObjectLockLegalHold.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to legalHold(ObjectLockLegalHold).

Parameters:

legalHold - a consumer that will call methods on ObjectLockLegalHold.Builder

Returns:

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

See Also:

legalHold(ObjectLockLegalHold)

requestPayer

PutObjectLegalHoldRequest.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

PutObjectLegalHoldRequest.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

versionId

PutObjectLegalHoldRequest.Builder versionId(String versionId)

The version ID of the object that you want to place a Legal Hold on.

Parameters:

versionId - The version ID of the object that you want to place a Legal Hold on.

Returns:

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

contentMD5

PutObjectLegalHoldRequest.Builder contentMD5(String contentMD5)

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Parameters:

contentMD5 - The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Returns:

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

expectedBucketOwner

PutObjectLegalHoldRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameters:

expectedBucketOwner - The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

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

overrideConfiguration

PutObjectLegalHoldRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder