Interface S3SetObjectRetentionOperation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<S3SetObjectRetentionOperation.Builder,
,S3SetObjectRetentionOperation> SdkBuilder<S3SetObjectRetentionOperation.Builder,
,S3SetObjectRetentionOperation> SdkPojo
- Enclosing class:
S3SetObjectRetentionOperation
public static interface S3SetObjectRetentionOperation.Builder
extends SdkPojo, CopyableBuilder<S3SetObjectRetentionOperation.Builder,S3SetObjectRetentionOperation>
-
Method Summary
Modifier and TypeMethodDescriptionbypassGovernanceRetention
(Boolean bypassGovernanceRetention) Indicates if the action should be applied to objects in the Batch Operations job even if they have Object LockGOVERNANCE
type in place.retention
(Consumer<S3Retention.Builder> retention) Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job.retention
(S3Retention retention) Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
bypassGovernanceRetention
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock
GOVERNANCE
type in place.- Parameters:
bypassGovernanceRetention
- Indicates if the action should be applied to objects in the Batch Operations job even if they have Object LockGOVERNANCE
type in place.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retention
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.
- Parameters:
retention
- Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retention
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.
This is a convenience method that creates an instance of theS3Retention.Builder
avoiding the need to create one manually viaS3Retention.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretention(S3Retention)
.- Parameters:
retention
- a consumer that will call methods onS3Retention.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-