com.ibm.cloud.objectstorage.services.s3.model.DeleteObjectTaggingRequest Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-bundle Show documentation
/*
* Copyright 2016-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;
/**
* Request object for the parameters to delete the tags for an object.
*/
public class DeleteObjectTaggingRequest extends AmazonWebServiceRequest implements Serializable
//IBM unsupported
//, ExpectedBucketOwnerRequest
{
private String bucketName;
private String key;
private String versionId;
//IBM unsupported
//private String expectedBucketOwner;
/**
* Constructs an instance of this object.
*
* @param bucketName
* The bucket name.
* @param key
* The object key.
*/
public DeleteObjectTaggingRequest(String bucketName, String key) {
this.bucketName = bucketName;
this.key = key;
}
//IBM unsupported
// public String getExpectedBucketOwner() {
// return expectedBucketOwner;
// }
//
// public DeleteObjectTaggingRequest withExpectedBucketOwner(String expectedBucketOwner) {
// this.expectedBucketOwner = expectedBucketOwner;
// return this;
// }
//
// public void setExpectedBucketOwner(String expectedBucketOwner) {
// withExpectedBucketOwner(expectedBucketOwner);
// }
/**
*
* The bucket name containing the objects from which to remove the tags.
*
*
* 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.
*
*
* When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this
* action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of
* the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @return The bucket name containing the objects from which to remove the tags.
*
* 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.
*
*
* When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When
* using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts
* in the Amazon S3 User Guide.
*/
public String getBucketName() {
return bucketName;
}
/**
*
* The bucket name containing the objects from which to remove the tags.
*
*
* 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.
*
*
* When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
* The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using
* this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in
* place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in
* the Amazon S3 User Guide.
*
*
* @param bucketName
* The bucket name containing the objects from which to remove the tags.
*
* 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.
*
*
* When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When
* using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on
* Outposts in the Amazon S3 User Guide.
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
*
* The bucket name containing the objects from which to remove the tags.
*
*
* 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.
*
*
* When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
* The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using
* this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in
* place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in
* the Amazon S3 User Guide.
*
*
* @param bucketName
* The bucket name containing the objects from which to remove the tags.
*
* 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.
*
*
* When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When
* using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on
* Outposts in the Amazon S3 User Guide.
*
* @return This object for chaining.
*/
public DeleteObjectTaggingRequest withBucketName(String bucketName) {
setBucketName(bucketName);
return this;
}
/**
* @return The object key.
*/
public String getKey() {
return key;
}
/**
* Set the object key.
*
* @param key
* The object key.
*/
public void setKey(String key) {
this.key = key;
}
/**
* Set the object key.
*
* @param key
* The object key.
*
* @return This object for chaining.
*/
public DeleteObjectTaggingRequest withKey(String key) {
setKey(key);
return this;
}
/**
* @return The version of the object whose tags are to be deleted.
*/
public String getVersionId() {
return versionId;
}
/**
* Set version of the object whose tages are to be deleted.
*
* @param versionId The object version.
*/
public void setVersionId(String versionId) {
this.versionId = versionId;
}
/**
* Set version of the object whose tages are to be deleted.
*
* @param versionId
* The object version.
*
* @return This object for chaining.
*/
public DeleteObjectTaggingRequest withVersionId(String versionId) {
setVersionId(versionId);
return this;
}
}