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

Interface GetObjectLegalHoldRequest.Builder

    • Method Detail

      • bucket

        GetObjectLegalHoldRequest.Builder bucket​(String bucket)

        The bucket name containing the object whose legal hold status you want to retrieve.

        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 whose legal hold status you want to retrieve.

        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

        GetObjectLegalHoldRequest.Builder key​(String key)

        The key name for the object whose legal hold status you want to retrieve.

        Parameters:
        key - The key name for the object whose legal hold status you want to retrieve.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionId

        GetObjectLegalHoldRequest.Builder versionId​(String versionId)

        The version ID of the object whose legal hold status you want to retrieve.

        Parameters:
        versionId - The version ID of the object whose legal hold status you want to retrieve.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestPayer

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

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

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