Package 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 Details

    • bucket

      PutObjectLegalHoldRequest.Builder bucket(String bucket)

      The bucket name containing the object that you want to place a legal hold on.

      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 containing the object that you want to place a legal hold on.

      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

      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 method 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:

    • 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

      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:

    • 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 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

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

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

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

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

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