software.amazon.awssdk.services.s3.model.PutObjectLockConfigurationRequest 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 PutObjectLockConfigurationRequest extends S3Request implements
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(PutObjectLockConfigurationRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build()).build();
private static final SdkField OBJECT_LOCK_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("ObjectLockConfiguration")
.getter(getter(PutObjectLockConfigurationRequest::objectLockConfiguration))
.setter(setter(Builder::objectLockConfiguration))
.constructor(ObjectLockConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ObjectLockConfiguration")
.unmarshallLocationName("ObjectLockConfiguration").build(), PayloadTrait.create()).build();
private static final SdkField REQUEST_PAYER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RequestPayer")
.getter(getter(PutObjectLockConfigurationRequest::requestPayerAsString))
.setter(setter(Builder::requestPayer))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-request-payer")
.unmarshallLocationName("x-amz-request-payer").build()).build();
private static final SdkField TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Token")
.getter(getter(PutObjectLockConfigurationRequest::token))
.setter(setter(Builder::token))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-bucket-object-lock-token")
.unmarshallLocationName("x-amz-bucket-object-lock-token").build()).build();
private static final SdkField CONTENT_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentMD5")
.getter(getter(PutObjectLockConfigurationRequest::contentMD5))
.setter(setter(Builder::contentMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-MD5")
.unmarshallLocationName("Content-MD5").build()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(PutObjectLockConfigurationRequest::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,
OBJECT_LOCK_CONFIGURATION_FIELD, REQUEST_PAYER_FIELD, TOKEN_FIELD, CONTENT_MD5_FIELD, EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final ObjectLockConfiguration objectLockConfiguration;
private final String requestPayer;
private final String token;
private final String contentMD5;
private final String expectedBucketOwner;
private PutObjectLockConfigurationRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.objectLockConfiguration = builder.objectLockConfiguration;
this.requestPayer = builder.requestPayer;
this.token = builder.token;
this.contentMD5 = builder.contentMD5;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The bucket whose Object Lock configuration you want to create or replace.
*
*
* @return The bucket whose Object Lock configuration you want to create or replace.
*/
public final String bucket() {
return bucket;
}
/**
*
* The Object Lock configuration that you want to apply to the specified bucket.
*
*
* @return The Object Lock configuration that you want to apply to the specified bucket.
*/
public final ObjectLockConfiguration objectLockConfiguration() {
return objectLockConfiguration;
}
/**
* Returns the value of the RequestPayer property for this object.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #requestPayer} will
* return {@link RequestPayer#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #requestPayerAsString}.
*
*
* @return The value of the RequestPayer property for this object.
* @see RequestPayer
*/
public final RequestPayer requestPayer() {
return RequestPayer.fromValue(requestPayer);
}
/**
* Returns the value of the RequestPayer property for this object.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #requestPayer} will
* return {@link RequestPayer#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #requestPayerAsString}.
*
*
* @return The value of the RequestPayer property for this object.
* @see RequestPayer
*/
public final String requestPayerAsString() {
return requestPayer;
}
/**
*
* A token to allow Object Lock to be enabled for an existing bucket.
*
*
* @return A token to allow Object Lock to be enabled for an existing bucket.
*/
public final String token() {
return token;
}
/**
*
* The MD5 hash for 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 for 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;
}
/**
*
* 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(objectLockConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(requestPayerAsString());
hashCode = 31 * hashCode + Objects.hashCode(token());
hashCode = 31 * hashCode + Objects.hashCode(contentMD5());
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 PutObjectLockConfigurationRequest)) {
return false;
}
PutObjectLockConfigurationRequest other = (PutObjectLockConfigurationRequest) obj;
return Objects.equals(bucket(), other.bucket())
&& Objects.equals(objectLockConfiguration(), other.objectLockConfiguration())
&& Objects.equals(requestPayerAsString(), other.requestPayerAsString()) && Objects.equals(token(), other.token())
&& Objects.equals(contentMD5(), other.contentMD5())
&& 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("PutObjectLockConfigurationRequest").add("Bucket", bucket())
.add("ObjectLockConfiguration", objectLockConfiguration()).add("RequestPayer", requestPayerAsString())
.add("Token", token()).add("ContentMD5", contentMD5()).add("ExpectedBucketOwner", expectedBucketOwner()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "ObjectLockConfiguration":
return Optional.ofNullable(clazz.cast(objectLockConfiguration()));
case "RequestPayer":
return Optional.ofNullable(clazz.cast(requestPayerAsString()));
case "Token":
return Optional.ofNullable(clazz.cast(token()));
case "ContentMD5":
return Optional.ofNullable(clazz.cast(contentMD5()));
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((PutObjectLockConfigurationRequest) 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 whose Object Lock configuration you want to create or replace.
*
*
* @param bucket
* The bucket whose Object Lock configuration you want to create or replace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* The Object Lock configuration that you want to apply to the specified bucket.
*
*
* @param objectLockConfiguration
* The Object Lock configuration that you want to apply to the specified bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder objectLockConfiguration(ObjectLockConfiguration objectLockConfiguration);
/**
*
* The Object Lock configuration that you want to apply to the specified bucket.
*
* This is a convenience that creates an instance of the {@link ObjectLockConfiguration.Builder} avoiding the
* need to create one manually via {@link ObjectLockConfiguration#builder()}.
*
* When the {@link Consumer} completes, {@link ObjectLockConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #objectLockConfiguration(ObjectLockConfiguration)}.
*
* @param objectLockConfiguration
* a consumer that will call methods on {@link ObjectLockConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #objectLockConfiguration(ObjectLockConfiguration)
*/
default Builder objectLockConfiguration(Consumer objectLockConfiguration) {
return objectLockConfiguration(ObjectLockConfiguration.builder().applyMutation(objectLockConfiguration).build());
}
/**
* Sets the value of the RequestPayer property for this object.
*
* @param requestPayer
* The new value for the RequestPayer property for this object.
* @see RequestPayer
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequestPayer
*/
Builder requestPayer(String requestPayer);
/**
* Sets the value of the RequestPayer property for this object.
*
* @param requestPayer
* The new value for the RequestPayer property for this object.
* @see RequestPayer
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequestPayer
*/
Builder requestPayer(RequestPayer requestPayer);
/**
*
* A token to allow Object Lock to be enabled for an existing bucket.
*
*
* @param token
* A token to allow Object Lock to be enabled for an existing bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder token(String token);
/**
*
* The MD5 hash for 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 for 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);
/**
*
* 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 ObjectLockConfiguration objectLockConfiguration;
private String requestPayer;
private String token;
private String contentMD5;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(PutObjectLockConfigurationRequest model) {
super(model);
bucket(model.bucket);
objectLockConfiguration(model.objectLockConfiguration);
requestPayer(model.requestPayer);
token(model.token);
contentMD5(model.contentMD5);
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 ObjectLockConfiguration.Builder getObjectLockConfiguration() {
return objectLockConfiguration != null ? objectLockConfiguration.toBuilder() : null;
}
public final void setObjectLockConfiguration(ObjectLockConfiguration.BuilderImpl objectLockConfiguration) {
this.objectLockConfiguration = objectLockConfiguration != null ? objectLockConfiguration.build() : null;
}
@Override
@Transient
public final Builder objectLockConfiguration(ObjectLockConfiguration objectLockConfiguration) {
this.objectLockConfiguration = objectLockConfiguration;
return this;
}
public final String getRequestPayer() {
return requestPayer;
}
public final void setRequestPayer(String requestPayer) {
this.requestPayer = requestPayer;
}
@Override
@Transient
public final Builder requestPayer(String requestPayer) {
this.requestPayer = requestPayer;
return this;
}
@Override
@Transient
public final Builder requestPayer(RequestPayer requestPayer) {
this.requestPayer(requestPayer == null ? null : requestPayer.toString());
return this;
}
public final String getToken() {
return token;
}
public final void setToken(String token) {
this.token = token;
}
@Override
@Transient
public final Builder token(String token) {
this.token = token;
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 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 PutObjectLockConfigurationRequest build() {
return new PutObjectLockConfigurationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy