software.amazon.awssdk.services.s3.model.PutBucketPolicyRequest Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.s3.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.PayloadTrait;
import software.amazon.awssdk.core.traits.RequiredTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutBucketPolicyRequest extends S3Request implements
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(PutBucketPolicyRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build(), RequiredTrait.create()).build();
private static final SdkField CONTENT_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentMD5")
.getter(getter(PutBucketPolicyRequest::contentMD5))
.setter(setter(Builder::contentMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-MD5")
.unmarshallLocationName("Content-MD5").build()).build();
private static final SdkField CHECKSUM_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumAlgorithm")
.getter(getter(PutBucketPolicyRequest::checksumAlgorithmAsString))
.setter(setter(Builder::checksumAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-sdk-checksum-algorithm")
.unmarshallLocationName("x-amz-sdk-checksum-algorithm").build()).build();
private static final SdkField CONFIRM_REMOVE_SELF_BUCKET_ACCESS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("ConfirmRemoveSelfBucketAccess")
.getter(getter(PutBucketPolicyRequest::confirmRemoveSelfBucketAccess))
.setter(setter(Builder::confirmRemoveSelfBucketAccess))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-confirm-remove-self-bucket-access")
.unmarshallLocationName("x-amz-confirm-remove-self-bucket-access").build()).build();
private static final SdkField POLICY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Policy")
.getter(getter(PutBucketPolicyRequest::policy))
.setter(setter(Builder::policy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Policy")
.unmarshallLocationName("Policy").build(), PayloadTrait.create(), RequiredTrait.create()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(PutBucketPolicyRequest::expectedBucketOwner))
.setter(setter(Builder::expectedBucketOwner))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-expected-bucket-owner")
.unmarshallLocationName("x-amz-expected-bucket-owner").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BUCKET_FIELD,
CONTENT_MD5_FIELD, CHECKSUM_ALGORITHM_FIELD, CONFIRM_REMOVE_SELF_BUCKET_ACCESS_FIELD, POLICY_FIELD,
EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final String contentMD5;
private final String checksumAlgorithm;
private final Boolean confirmRemoveSelfBucketAccess;
private final String policy;
private final String expectedBucketOwner;
private PutBucketPolicyRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.contentMD5 = builder.contentMD5;
this.checksumAlgorithm = builder.checksumAlgorithm;
this.confirmRemoveSelfBucketAccess = builder.confirmRemoveSelfBucketAccess;
this.policy = builder.policy;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The name of the bucket.
*
*
* @return The name of the bucket.
*/
public final String bucket() {
return bucket;
}
/**
*
* The MD5 hash of the request body.
*
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this
* field is calculated automatically.
*
*
* @return The MD5 hash of the request body.
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
* this field is calculated automatically.
*/
public final String contentMD5() {
return contentMD5;
}
/**
*
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
* provide any additional functionality if not using the SDK. When sending this header, there must be a
* corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails
* the request with the HTTP status code 400 Bad Request. For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return Indicates the algorithm used to create the checksum for the object when using the SDK. This header will
* not provide any additional functionality if not using the SDK. When sending this header, there must be a
* corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3
* fails the request with the HTTP status code 400 Bad Request. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
* parameter.
* @see ChecksumAlgorithm
*/
public final ChecksumAlgorithm checksumAlgorithm() {
return ChecksumAlgorithm.fromValue(checksumAlgorithm);
}
/**
*
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
* provide any additional functionality if not using the SDK. When sending this header, there must be a
* corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails
* the request with the HTTP status code 400 Bad Request. For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return Indicates the algorithm used to create the checksum for the object when using the SDK. This header will
* not provide any additional functionality if not using the SDK. When sending this header, there must be a
* corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3
* fails the request with the HTTP status code 400 Bad Request. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
* parameter.
* @see ChecksumAlgorithm
*/
public final String checksumAlgorithmAsString() {
return checksumAlgorithm;
}
/**
*
* Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in
* the future.
*
*
* @return Set this parameter to true to confirm that you want to remove your permissions to change this bucket
* policy in the future.
*/
public final Boolean confirmRemoveSelfBucketAccess() {
return confirmRemoveSelfBucketAccess;
}
/**
*
* The bucket policy as a JSON document.
*
*
* @return The bucket policy as a JSON document.
*/
public final String policy() {
return policy;
}
/**
*
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
* with the HTTP status code 403 Forbidden (access denied).
*
*
* @return The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
* fails with the HTTP status code 403 Forbidden (access denied).
*/
public final String expectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(bucket());
hashCode = 31 * hashCode + Objects.hashCode(contentMD5());
hashCode = 31 * hashCode + Objects.hashCode(checksumAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(confirmRemoveSelfBucketAccess());
hashCode = 31 * hashCode + Objects.hashCode(policy());
hashCode = 31 * hashCode + Objects.hashCode(expectedBucketOwner());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutBucketPolicyRequest)) {
return false;
}
PutBucketPolicyRequest other = (PutBucketPolicyRequest) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(contentMD5(), other.contentMD5())
&& Objects.equals(checksumAlgorithmAsString(), other.checksumAlgorithmAsString())
&& Objects.equals(confirmRemoveSelfBucketAccess(), other.confirmRemoveSelfBucketAccess())
&& Objects.equals(policy(), other.policy()) && Objects.equals(expectedBucketOwner(), other.expectedBucketOwner());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("PutBucketPolicyRequest").add("Bucket", bucket()).add("ContentMD5", contentMD5())
.add("ChecksumAlgorithm", checksumAlgorithmAsString())
.add("ConfirmRemoveSelfBucketAccess", confirmRemoveSelfBucketAccess()).add("Policy", policy())
.add("ExpectedBucketOwner", expectedBucketOwner()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "ContentMD5":
return Optional.ofNullable(clazz.cast(contentMD5()));
case "ChecksumAlgorithm":
return Optional.ofNullable(clazz.cast(checksumAlgorithmAsString()));
case "ConfirmRemoveSelfBucketAccess":
return Optional.ofNullable(clazz.cast(confirmRemoveSelfBucketAccess()));
case "Policy":
return Optional.ofNullable(clazz.cast(policy()));
case "ExpectedBucketOwner":
return Optional.ofNullable(clazz.cast(expectedBucketOwner()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutBucketPolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the bucket.
*
*
* @param bucket
* The name of the bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* The MD5 hash of the request body.
*
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
* this field is calculated automatically.
*
*
* @param contentMD5
* The MD5 hash of the request body.
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services
* SDKs, this field is calculated automatically.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentMD5(String contentMD5);
/**
*
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
* provide any additional functionality if not using the SDK. When sending this header, there must be a
* corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3
* fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
* parameter.
*
*
* @param checksumAlgorithm
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header
* will not provide any additional functionality if not using the SDK. When sending this header, there
* must be a corresponding x-amz-checksum or x-amz-trailer header sent.
* Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For
* more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
* parameter.
* @see ChecksumAlgorithm
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAlgorithm
*/
Builder checksumAlgorithm(String checksumAlgorithm);
/**
*
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
* provide any additional functionality if not using the SDK. When sending this header, there must be a
* corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3
* fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
* parameter.
*
*
* @param checksumAlgorithm
* Indicates the algorithm used to create the checksum for the object when using the SDK. This header
* will not provide any additional functionality if not using the SDK. When sending this header, there
* must be a corresponding x-amz-checksum or x-amz-trailer header sent.
* Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For
* more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
* parameter.
* @see ChecksumAlgorithm
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAlgorithm
*/
Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm);
/**
*
* Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy
* in the future.
*
*
* @param confirmRemoveSelfBucketAccess
* Set this parameter to true to confirm that you want to remove your permissions to change this bucket
* policy in the future.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder confirmRemoveSelfBucketAccess(Boolean confirmRemoveSelfBucketAccess);
/**
*
* The bucket policy as a JSON document.
*
*
* @param policy
* The bucket policy as a JSON document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policy(String policy);
/**
*
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
* with the HTTP status code 403 Forbidden (access denied).
*
*
* @param expectedBucketOwner
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the
* request fails with the HTTP status code 403 Forbidden (access denied).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expectedBucketOwner(String expectedBucketOwner);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3Request.BuilderImpl implements Builder {
private String bucket;
private String contentMD5;
private String checksumAlgorithm;
private Boolean confirmRemoveSelfBucketAccess;
private String policy;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(PutBucketPolicyRequest model) {
super(model);
bucket(model.bucket);
contentMD5(model.contentMD5);
checksumAlgorithm(model.checksumAlgorithm);
confirmRemoveSelfBucketAccess(model.confirmRemoveSelfBucketAccess);
policy(model.policy);
expectedBucketOwner(model.expectedBucketOwner);
}
public final String getBucket() {
return bucket;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
@Override
public final Builder bucket(String bucket) {
this.bucket = bucket;
return this;
}
public final String getContentMD5() {
return contentMD5;
}
public final void setContentMD5(String contentMD5) {
this.contentMD5 = contentMD5;
}
@Override
public final Builder contentMD5(String contentMD5) {
this.contentMD5 = contentMD5;
return this;
}
public final String getChecksumAlgorithm() {
return checksumAlgorithm;
}
public final void setChecksumAlgorithm(String checksumAlgorithm) {
this.checksumAlgorithm = checksumAlgorithm;
}
@Override
public final Builder checksumAlgorithm(String checksumAlgorithm) {
this.checksumAlgorithm = checksumAlgorithm;
return this;
}
@Override
public final Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) {
this.checksumAlgorithm(checksumAlgorithm == null ? null : checksumAlgorithm.toString());
return this;
}
public final Boolean getConfirmRemoveSelfBucketAccess() {
return confirmRemoveSelfBucketAccess;
}
public final void setConfirmRemoveSelfBucketAccess(Boolean confirmRemoveSelfBucketAccess) {
this.confirmRemoveSelfBucketAccess = confirmRemoveSelfBucketAccess;
}
@Override
public final Builder confirmRemoveSelfBucketAccess(Boolean confirmRemoveSelfBucketAccess) {
this.confirmRemoveSelfBucketAccess = confirmRemoveSelfBucketAccess;
return this;
}
public final String getPolicy() {
return policy;
}
public final void setPolicy(String policy) {
this.policy = policy;
}
@Override
public final Builder policy(String policy) {
this.policy = policy;
return this;
}
public final String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public final void setExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
}
@Override
public final Builder expectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutBucketPolicyRequest build() {
return new PutBucketPolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}