com.amazonaws.services.s3.model.SetObjectLegalHoldRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3 Show documentation
/*
* Copyright 2018-2024 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.amazonaws.services.s3.model;
import com.amazonaws.AmazonWebServiceRequest;
import java.io.Serializable;
/**
* Applies a Legal Hold configuration to the specified object.
*/
public class SetObjectLegalHoldRequest extends AmazonWebServiceRequest implements Serializable, ExpectedBucketOwnerRequest {
private String bucket;
private String key;
private ObjectLockLegalHold legalHold;
private boolean isRequesterPays;
private String versionId;
private String expectedBucketOwner;
public String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public SetObjectLegalHoldRequest withExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public void setExpectedBucketOwner(String expectedBucketOwner) {
withExpectedBucketOwner(expectedBucketOwner);
}
/**
*
* The bucket name containing the object that you want to place a Legal Hold on.
*
*
* 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 name containing the object that you want to place a Legal Hold on.
*
* 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 name containing the object that you want to place a Legal Hold on.
*
*
* 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 name containing the object that you want to place a Legal Hold on.
*
* 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 SetObjectLegalHoldRequest withBucketName(String bucket) {
this.bucket = bucket;
return this;
}
/**
*
* The bucket name containing the object that you want to place a Legal Hold on.
*
*
* 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 name containing the object that you want to place a Legal Hold on.
*
* 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);
}
/**
* The Object Key.
*/
public String getKey() {
return key;
}
/**
* The Object Key.
*/
public SetObjectLegalHoldRequest withKey(String key) {
this.key = key;
return this;
}
/**
* The Object Key.
*/
public void setKey(String key) {
withKey(key);
}
/**
* Container element for the Legal Hold configuration you want to apply to the specified object.
*/
public ObjectLockLegalHold getLegalHold() {
return legalHold;
}
/**
* Container element for the Legal Hold configuration you want to apply to the specified object.
*/
public SetObjectLegalHoldRequest withLegalHold(ObjectLockLegalHold legalHold) {
this.legalHold = legalHold;
return this;
}
/**
* Container element for the Legal Hold configuration you want to apply to the specified object.
*/
public void setLegalHold(ObjectLockLegalHold legalHold) {
withLegalHold(legalHold);
}
/**
* 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 SetObjectLegalHoldRequest 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;
}
/**
* The Object Version ID.
*/
public String getVersionId() {
return versionId;
}
/**
* The Object Version ID.
*/
public SetObjectLegalHoldRequest withVersionId(String versionId) {
this.versionId = versionId;
return this;
}
/**
* The Object Version ID.
*/
public void setVersionId(String versionId) {
withVersionId(versionId);
}
}