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

Interface PutObjectRetentionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>, S3Request.Builder, SdkBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutObjectRetentionRequest
public static interface PutObjectRetentionRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>

  • Method Details

    • bucket

      PutObjectRetentionRequest.Builder bucket(String bucket)

      The bucket name that contains the object you want to apply this Object Retention configuration to.

      Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point 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 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 that contains the object you want to apply this Object Retention configuration to.

      Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point 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 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

      PutObjectRetentionRequest.Builder key(String key)

      The key name for the object that you want to apply this Object Retention configuration to.

      Parameters:
      key - The key name for the object that you want to apply this Object Retention configuration to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retention

      PutObjectRetentionRequest.Builder retention(ObjectLockRetention retention)

      The container element for the Object Retention configuration.

      Parameters:
      retention - The container element for the Object Retention configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retention

      default PutObjectRetentionRequest.Builder retention(Consumer<ObjectLockRetention.Builder> retention)

      The container element for the Object Retention configuration.

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

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

      Parameters:
      retention - a consumer that will call methods on ObjectLockRetention.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestPayer

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

      PutObjectRetentionRequest.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:

    • versionId

      PutObjectRetentionRequest.Builder versionId(String versionId)

      The version ID for the object that you want to apply this Object Retention configuration to.

      Parameters:
      versionId - The version ID for the object that you want to apply this Object Retention configuration to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bypassGovernanceRetention

      PutObjectRetentionRequest.Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention)

      Indicates whether this action should bypass Governance-mode restrictions.

      Parameters:
      bypassGovernanceRetention - Indicates whether this action should bypass Governance-mode restrictions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentMD5

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

      PutObjectRetentionRequest.Builder checksumAlgorithm(String checksumAlgorithm)

      Indicates the algorithm used to create the checksum for the object 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 object 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

      PutObjectRetentionRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

      Indicates the algorithm used to create the checksum for the object 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 object 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:

    • expectedBucketOwner

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

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

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