com.ibm.cloud.objectstorage.services.s3.model.SetObjectLockConfigurationRequest Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-s3 Show documentation
/*
* 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;
/**
* Places an Object Lock configuration on the specified 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 SetObjectLockConfigurationRequest extends AmazonWebServiceRequest implements Serializable, ExpectedBucketOwnerRequest {
private String bucket;
private ObjectLockConfiguration objectLockConfiguration;
private boolean isRequesterPays;
private String token;
private String expectedBucketOwner;
public String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public SetObjectLockConfigurationRequest withExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public void setExpectedBucketOwner(String expectedBucketOwner) {
withExpectedBucketOwner(expectedBucketOwner);
}
/**
* The S3 Bucket.
*/
public String getBucketName() {
return bucket;
}
/**
* The S3 Bucket.
*
*
* When using this API 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 operation using 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 Simple Storage Service Developer Guide.
*
*/
public SetObjectLockConfigurationRequest withBucketName(String bucket) {
this.bucket = bucket;
return this;
}
/**
* The S3 Bucket.
*
*
* When using this API 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 operation using 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 Simple Storage Service Developer Guide.
*
*/
public void setBucketName(String bucket) {
withBucketName(bucket);
}
/**
* The Object Lock configuration that you want to apply to the specified bucket.
*/
public ObjectLockConfiguration getObjectLockConfiguration() {
return objectLockConfiguration;
}
/**
* The Object Lock configuration that you want to apply to the specified bucket.
*/
public SetObjectLockConfigurationRequest withObjectLockConfiguration(ObjectLockConfiguration objectLockConfiguration) {
this.objectLockConfiguration = objectLockConfiguration;
return this;
}
/**
* The Object Lock configuration that you want to apply to the specified bucket.
*/
public void setObjectLockConfiguration(ObjectLockConfiguration objectLockConfiguration) {
withObjectLockConfiguration(objectLockConfiguration);
}
/**
* Returns true if the user has enabled Requester Pays option when
* downloading an object from Requester Pays Bucket; else false.
*
*
* If a bucket is enabled for Requester Pays, then any attempt to read an
* object from it without Requester Pays enabled will result in a 403 error
* and the bucket owner will be charged for the request.
*
*
* Enabling Requester Pays disables the ability to have anonymous access to
* this bucket
*
* @return true if the user has enabled Requester Pays option for
* downloading an object from Requester Pays Bucket.
*/
public boolean isRequesterPays() {
return isRequesterPays;
}
/**
* Used for conducting this operation from a Requester Pays Bucket. If
* set the requester is charged for requests from the bucket. It returns this
* updated GetObjectRequest object so that additional method calls can be
* chained together.
*
*
* If a bucket is enabled for Requester Pays, then any attempt to upload or
* download an object from it without Requester Pays enabled will result in
* a 403 error and the bucket owner will be charged for the request.
*
*
* Enabling Requester Pays disables the ability to have anonymous access to
* this bucket.
*
* @param isRequesterPays
* Enable Requester Pays option for the operation.
*
* @return The updated GetObjectRequest object.
*/
public SetObjectLockConfigurationRequest withRequesterPays(boolean isRequesterPays) {
this.isRequesterPays = isRequesterPays;
return this;
}
/**
* Used for downloading an Amazon S3 Object from a Requester Pays Bucket. If
* set the requester is charged for downloading the data from the bucket.
*
*
* If a bucket is enabled for Requester Pays, then any attempt to read an
* object from it without Requester Pays enabled will result in a 403 error
* and the bucket owner will be charged for the request.
*
*
* Enabling Requester Pays disables the ability to have anonymous access to
* this bucket
*
* @param isRequesterPays
* Enable Requester Pays option for the operation.
*/
public void setRequesterPays(boolean isRequesterPays) {
this.isRequesterPays = isRequesterPays;
}
public String getToken() {
return token;
}
public SetObjectLockConfigurationRequest withToken(String token) {
this.token = token;
return this;
}
public void setToken(String token) {
withToken(token);
}
}