software.amazon.awssdk.services.s3.model.PutBucketVersioningRequest Maven / Gradle / Ivy
/*
* 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.beans.Transient;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutBucketVersioningRequest extends S3Request implements
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(PutBucketVersioningRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build()).build();
private static final SdkField CONTENT_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentMD5")
.getter(getter(PutBucketVersioningRequest::contentMD5))
.setter(setter(Builder::contentMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-MD5")
.unmarshallLocationName("Content-MD5").build()).build();
private static final SdkField MFA_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("MFA")
.getter(getter(PutBucketVersioningRequest::mfa))
.setter(setter(Builder::mfa))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-mfa")
.unmarshallLocationName("x-amz-mfa").build()).build();
private static final SdkField VERSIONING_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("VersioningConfiguration")
.getter(getter(PutBucketVersioningRequest::versioningConfiguration))
.setter(setter(Builder::versioningConfiguration))
.constructor(VersioningConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VersioningConfiguration")
.unmarshallLocationName("VersioningConfiguration").build(), PayloadTrait.create()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(PutBucketVersioningRequest::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, MFA_FIELD, VERSIONING_CONFIGURATION_FIELD, EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final String contentMD5;
private final String mfa;
private final VersioningConfiguration versioningConfiguration;
private final String expectedBucketOwner;
private PutBucketVersioningRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.contentMD5 = builder.contentMD5;
this.mfa = builder.mfa;
this.versioningConfiguration = builder.versioningConfiguration;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The bucket name.
*
*
* @return The bucket name.
*/
public final String bucket() {
return bucket;
}
/**
*
* >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to
* verify that the request body was not corrupted in transit. For more information, see RFC 1864.
*
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this
* field is calculated automatically.
*
*
* @return >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity
* check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
*
* 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;
}
/**
*
* The concatenation of the authentication device's serial number, a space, and the value that is displayed on your
* authentication device.
*
*
* @return The concatenation of the authentication device's serial number, a space, and the value that is displayed
* on your authentication device.
*/
public final String mfa() {
return mfa;
}
/**
*
* Container for setting the versioning state.
*
*
* @return Container for setting the versioning state.
*/
public final VersioningConfiguration versioningConfiguration() {
return versioningConfiguration;
}
/**
*
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail
* with an HTTP 403 (Access Denied) error.
*
*
* @return The account ID of the expected bucket owner. If the bucket is owned by a different account, the request
* will fail with an HTTP 403 (Access Denied) error.
*/
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(mfa());
hashCode = 31 * hashCode + Objects.hashCode(versioningConfiguration());
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 PutBucketVersioningRequest)) {
return false;
}
PutBucketVersioningRequest other = (PutBucketVersioningRequest) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(contentMD5(), other.contentMD5())
&& Objects.equals(mfa(), other.mfa())
&& Objects.equals(versioningConfiguration(), other.versioningConfiguration())
&& 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("PutBucketVersioningRequest").add("Bucket", bucket()).add("ContentMD5", contentMD5())
.add("MFA", mfa()).add("VersioningConfiguration", versioningConfiguration())
.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 "MFA":
return Optional.ofNullable(clazz.cast(mfa()));
case "VersioningConfiguration":
return Optional.ofNullable(clazz.cast(versioningConfiguration()));
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((PutBucketVersioningRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The bucket name.
*
*
* @param bucket
* The bucket name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check
* to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
*
*
* 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 base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity
* check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
*
* 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);
/**
*
* The concatenation of the authentication device's serial number, a space, and the value that is displayed on
* your authentication device.
*
*
* @param mfa
* The concatenation of the authentication device's serial number, a space, and the value that is
* displayed on your authentication device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mfa(String mfa);
/**
*
* Container for setting the versioning state.
*
*
* @param versioningConfiguration
* Container for setting the versioning state.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versioningConfiguration(VersioningConfiguration versioningConfiguration);
/**
*
* Container for setting the versioning state.
*
* This is a convenience that creates an instance of the {@link VersioningConfiguration.Builder} avoiding the
* need to create one manually via {@link VersioningConfiguration#builder()}.
*
* When the {@link Consumer} completes, {@link VersioningConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #versioningConfiguration(VersioningConfiguration)}.
*
* @param versioningConfiguration
* a consumer that will call methods on {@link VersioningConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #versioningConfiguration(VersioningConfiguration)
*/
default Builder versioningConfiguration(Consumer versioningConfiguration) {
return versioningConfiguration(VersioningConfiguration.builder().applyMutation(versioningConfiguration).build());
}
/**
*
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will
* fail with an HTTP 403 (Access Denied) error.
*
*
* @param expectedBucketOwner
* The account ID of the expected bucket owner. If the bucket is owned by a different account, the
* request will fail with an HTTP 403 (Access Denied) error.
* @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 mfa;
private VersioningConfiguration versioningConfiguration;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(PutBucketVersioningRequest model) {
super(model);
bucket(model.bucket);
contentMD5(model.contentMD5);
mfa(model.mfa);
versioningConfiguration(model.versioningConfiguration);
expectedBucketOwner(model.expectedBucketOwner);
}
public final String getBucket() {
return bucket;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
@Override
@Transient
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
@Transient
public final Builder contentMD5(String contentMD5) {
this.contentMD5 = contentMD5;
return this;
}
public final String getMfa() {
return mfa;
}
public final void setMfa(String mfa) {
this.mfa = mfa;
}
@Override
@Transient
public final Builder mfa(String mfa) {
this.mfa = mfa;
return this;
}
public final VersioningConfiguration.Builder getVersioningConfiguration() {
return versioningConfiguration != null ? versioningConfiguration.toBuilder() : null;
}
public final void setVersioningConfiguration(VersioningConfiguration.BuilderImpl versioningConfiguration) {
this.versioningConfiguration = versioningConfiguration != null ? versioningConfiguration.build() : null;
}
@Override
@Transient
public final Builder versioningConfiguration(VersioningConfiguration versioningConfiguration) {
this.versioningConfiguration = versioningConfiguration;
return this;
}
public final String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public final void setExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
}
@Override
@Transient
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 PutBucketVersioningRequest build() {
return new PutBucketVersioningRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy