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

Interface PutBucketLifecycleConfigurationRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutBucketLifecycleConfigurationRequest

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

Method Summary

Modifier and Type	Method and Description
PutBucketLifecycleConfigurationRequest.Builder	bucket(String bucket) The name of the bucket for which to set the configuration.
PutBucketLifecycleConfigurationRequest.Builder	checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the request when you use the SDK.
PutBucketLifecycleConfigurationRequest.Builder	checksumAlgorithm(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the request when you use the SDK.
PutBucketLifecycleConfigurationRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
PutBucketLifecycleConfigurationRequest.Builder	lifecycleConfiguration(BucketLifecycleConfiguration lifecycleConfiguration) Container for lifecycle rules.
default PutBucketLifecycleConfigurationRequest.Builder	lifecycleConfiguration(Consumer<BucketLifecycleConfiguration.Builder> lifecycleConfiguration) Container for lifecycle rules.
PutBucketLifecycleConfigurationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutBucketLifecycleConfigurationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PutBucketLifecycleConfigurationRequest.Builder	transitionDefaultMinimumObjectSize(String transitionDefaultMinimumObjectSize) Indicates which default minimum object size behavior is applied to the lifecycle configuration.
PutBucketLifecycleConfigurationRequest.Builder	transitionDefaultMinimumObjectSize(TransitionDefaultMinimumObjectSize transitionDefaultMinimumObjectSize) Indicates which default minimum object size behavior is applied to the lifecycle configuration.

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

PutBucketLifecycleConfigurationRequest.Builder bucket(String bucket)

The name of the bucket for which to set the configuration.

Parameters:

bucket - The name of the bucket for which to set the configuration.

Returns:

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

checksumAlgorithm

PutBucketLifecycleConfigurationRequest.Builder checksumAlgorithm(String checksumAlgorithm)

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not 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 request when you use the SDK. This header will not 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

PutBucketLifecycleConfigurationRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not 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 request when you use the SDK. This header will not 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

lifecycleConfiguration

PutBucketLifecycleConfigurationRequest.Builder lifecycleConfiguration(BucketLifecycleConfiguration lifecycleConfiguration)

Container for lifecycle rules. You can add as many as 1,000 rules.

Parameters:

lifecycleConfiguration - Container for lifecycle rules. You can add as many as 1,000 rules.

Returns:

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

lifecycleConfiguration

default PutBucketLifecycleConfigurationRequest.Builder lifecycleConfiguration(Consumer<BucketLifecycleConfiguration.Builder> lifecycleConfiguration)

Container for lifecycle rules. You can add as many as 1,000 rules.

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

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

Parameters:

lifecycleConfiguration - a consumer that will call methods on BucketLifecycleConfiguration.Builder

Returns:

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

See Also:

lifecycleConfiguration(BucketLifecycleConfiguration)

expectedBucketOwner

PutBucketLifecycleConfigurationRequest.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).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

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

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

Returns:

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

transitionDefaultMinimumObjectSize

PutBucketLifecycleConfigurationRequest.Builder transitionDefaultMinimumObjectSize(String transitionDefaultMinimumObjectSize)

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

• all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

• varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

Parameters:

transitionDefaultMinimumObjectSize - Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

• all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

• varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

Returns:

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

See Also:

TransitionDefaultMinimumObjectSize, TransitionDefaultMinimumObjectSize

transitionDefaultMinimumObjectSize

PutBucketLifecycleConfigurationRequest.Builder transitionDefaultMinimumObjectSize(TransitionDefaultMinimumObjectSize transitionDefaultMinimumObjectSize)

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

• all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

• varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

Parameters:

transitionDefaultMinimumObjectSize - Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

• all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

• varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

Returns:

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

See Also:

TransitionDefaultMinimumObjectSize, TransitionDefaultMinimumObjectSize

overrideConfiguration

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

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