com.ibm.cos.v2.services.s3.model

Interface GetObjectRetentionRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetObjectRetentionRequest

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

Method Summary

Modifier and Type	Method and Description
GetObjectRetentionRequest.Builder	bucket(String bucket) The bucket name containing the object whose retention settings you want to retrieve.
GetObjectRetentionRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
GetObjectRetentionRequest.Builder	key(String key) The key name for the object whose retention settings you want to retrieve.
GetObjectRetentionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetObjectRetentionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetObjectRetentionRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectRetentionRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectRetentionRequest.Builder	versionId(String versionId) The version ID for the object whose retention settings you want to retrieve.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Request.Builder

build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

bucket

GetObjectRetentionRequest.Builder bucket(String bucket)

The bucket name containing the object whose retention settings you want to retrieve.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 action 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 Using access points in the Amazon S3 User Guide.

Parameters:

bucket - The bucket name containing the object whose retention settings you want to retrieve.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 action 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 Using access points in the Amazon S3 User Guide.

Returns:

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

key

GetObjectRetentionRequest.Builder key(String key)

The key name for the object whose retention settings you want to retrieve.

Parameters:

key - The key name for the object whose retention settings you want to retrieve.

Returns:

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

versionId

GetObjectRetentionRequest.Builder versionId(String versionId)

The version ID for the object whose retention settings you want to retrieve.

Parameters:

versionId - The version ID for the object whose retention settings you want to retrieve.

Returns:

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

requestPayer

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

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

GetObjectRetentionRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected bucket owner. If the account ID that you provide does not 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 does not 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.

overrideConfiguration

GetObjectRetentionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.