com.ibm.cloud.objectstorage.services.s3.model.GetObjectLockConfigurationRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibm-cos-java-sdk-s3 Show documentation
The IBM COS Java SDK for Amazon S3 module holds the client classes that are used for communicating with IBM Cloud Object Storage Service
The newest version!
/*
 * Copyright 2018-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package com.ibm.cloud.objectstorage.services.s3.model;

import com.ibm.cloud.objectstorage.AmazonWebServiceRequest;
import java.io.Serializable;

/**
 * Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by
 * default to every new object placed in the specified bucket.
 */
public class GetObjectLockConfigurationRequest extends AmazonWebServiceRequest implements Serializable, ExpectedBucketOwnerRequest {
    private String bucket;

    private String expectedBucketOwner;

    /**
     * 
     * The bucket whose Object Lock configuration you want to retrieve.
     * 
     * 
     * When using this action with an access point, 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.
     * 
     *
     * @return The bucket whose Object Lock configuration you want to retrieve.
     *         
     *         When using this action with an access point, 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.
     */
    public String getBucketName() {
        return bucket;
    }

    /**
     * 

     * The bucket whose Object Lock configuration you want to retrieve.
     * 
     * 
     * When using this action with an access point, 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.
     * 
     *
     * @param bucket
     *        The bucket whose Object Lock configuration you want to retrieve.
     *        
     *        When using this action with an access point, 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.
     * @return Returns a reference to this object so that method calls can be chained together.
     */
    public GetObjectLockConfigurationRequest withBucketName(String bucket) {
        this.bucket = bucket;
        return this;
    }

    /**
     * 

     * The bucket whose Object Lock configuration you want to retrieve.
     * 
     * 
     * When using this action with an access point, 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.
     * 
     *
     * @param bucket
     *        The bucket whose Object Lock configuration you want to retrieve.
     *        
     *        When using this action with an access point, 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.
     */
    public void setBucketName(String bucket) {
        withBucketName(bucket);
    }

    public String getExpectedBucketOwner() {
        return expectedBucketOwner;
    }

    public GetObjectLockConfigurationRequest withExpectedBucketOwner(String expectedBucketOwner) {
        this.expectedBucketOwner = expectedBucketOwner;
        return this;
    }

    public void setExpectedBucketOwner(String expectedBucketOwner) {
        withExpectedBucketOwner(expectedBucketOwner);
    }
}